List Web3 Hostnames

GET

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/web3/hostnames

Last modified:2022-12-16 13:48:35

Request

Path Params

zone_identifier

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200List Web3 Hostnames response

application/json

Body

result

required

Any of

allOf {2}

array[object (web3-hostname) {8}]

allOf {2}

One of

array[object (web3-hostname) {8}]

object

created_on

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

description

string

web3-hostname_components-schemas-description

optional

An optional description of the hostname.

<= 500 characters

Example:

This is my IPFS gateway.

dnslink

string

dnslink

optional

DNSLink value used if the target is ipfs.

Example:

/ipns/onboarding.ipfs.cloudflare.com

string

common_components-schemas-identifier

read-onlyoptional

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

modified_on

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

name

string

web3-hostname_components-schemas-name

read-onlyoptional

The hostname that will point to the target gateway via CNAME.

<= 255 characters

Example:

gateway.example.com

status

enum<string>

web3-hostname_components-schemas-status

read-onlyoptional

Status of the hostname's activation.

Allowed values:

activependingdeletingerror

Example:

active

target

enum<string>

components-schemas-target

optional

Target gateway of the hostname.

Allowed values:

ethereumipfsipfs_universal_pathpolygon

Example:

ipfs

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "created_on": "2014-01-01T05:20:00.12345Z",
            "description": "This is my IPFS gateway.",
            "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
            "id": "023e105f4ecef8ad9ca31a8372d0c353",
            "modified_on": "2014-01-01T05:20:00.12345Z",
            "name": "gateway.example.com",
            "status": "active",
            "target": "ipfs"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

🟢200List Web3 Hostnames response failure

Modified at 2022-12-16 13:48:35

Get waiting room status

Create Web3 Hostname