Skip to content
Cloudflare API
Start here
API Reference

Web3

Web3Hostnames

List Web3 Hostnames
client.web3.hostnames.list(HostnameListParams { zone_id } params, RequestOptionsoptions?): SinglePage<Hostname { id, created_on, description, 5 more } >
GET/zones/{zone_id}/web3/hostnames
Web3 Hostname Details
client.web3.hostnames.get(stringidentifier, HostnameGetParams { zone_id } params, RequestOptionsoptions?): Hostname { id, created_on, description, 5 more }
GET/zones/{zone_id}/web3/hostnames/{identifier}
Create Web3 Hostname
client.web3.hostnames.create(HostnameCreateParams { zone_id, name, target, 2 more } params, RequestOptionsoptions?): Hostname { id, created_on, description, 5 more }
POST/zones/{zone_id}/web3/hostnames
Edit Web3 Hostname
client.web3.hostnames.edit(stringidentifier, HostnameEditParams { zone_id, description, dnslink } params, RequestOptionsoptions?): Hostname { id, created_on, description, 5 more }
PATCH/zones/{zone_id}/web3/hostnames/{identifier}
Delete Web3 Hostname
client.web3.hostnames.delete(stringidentifier, HostnameDeleteParams { zone_id } params, RequestOptionsoptions?): HostnameDeleteResponse { id } | null
DELETE/zones/{zone_id}/web3/hostnames/{identifier}
ModelsExpand Collapse
Hostname { id, created_on, description, 5 more }
id?: string

Specify the identifier of the hostname.

maxLength32
created_on?: string
formatdate-time
description?: string

Specify an optional description of the hostname.

maxLength500
modified_on?: string
formatdate-time
name?: string

Specify the hostname that points to the target gateway via CNAME.

maxLength255
status?: "active" | "pending" | "deleting" | "error"

Specifies the status of the hostname's activation.

One of the following:
"active"
"pending"
"deleting"
"error"
target?: "ethereum" | "ipfs" | "ipfs_universal_path"

Specify the target gateway of the hostname.

One of the following:
"ethereum"
"ipfs"
"ipfs_universal_path"
HostnameDeleteResponse { id }
id: string

Specify the identifier of the hostname.

maxLength32

Web3HostnamesIPFS Universal Paths

Web3HostnamesIPFS Universal PathsContent Lists

IPFS Universal Path Gateway Content List Details
client.web3.hostnames.ipfsUniversalPaths.contentLists.get(stringidentifier, ContentListGetParams { zone_id } params, RequestOptionsoptions?): ContentList { action }
GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list
Update IPFS Universal Path Gateway Content List
client.web3.hostnames.ipfsUniversalPaths.contentLists.update(stringidentifier, ContentListUpdateParams { zone_id, action, entries } params, RequestOptionsoptions?): ContentList { action }
PUT/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list
ModelsExpand Collapse
ContentList { action }
action?: "block"

Behavior of the content list.

Web3HostnamesIPFS Universal PathsContent ListsEntries

List IPFS Universal Path Gateway Content List Entries
client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.list(stringidentifier, EntryListParams { zone_id } params, RequestOptionsoptions?): EntryListResponse { entries } | null
GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries
IPFS Universal Path Gateway Content List Entry Details
client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.get(stringidentifier, stringcontentListEntryIdentifier, EntryGetParams { zone_id } params, RequestOptionsoptions?): EntryGetResponse { id, content, created_on, 3 more }
GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
Create IPFS Universal Path Gateway Content List Entry
client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.create(stringidentifier, EntryCreateParams { zone_id, content, type, description } params, RequestOptionsoptions?): EntryCreateResponse { id, content, created_on, 3 more }
POST/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries
Edit IPFS Universal Path Gateway Content List Entry
client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.update(stringidentifier, stringcontentListEntryIdentifier, EntryUpdateParams { zone_id, content, type, description } params, RequestOptionsoptions?): EntryUpdateResponse { id, content, created_on, 3 more }
PUT/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
Delete IPFS Universal Path Gateway Content List Entry
client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.delete(stringidentifier, stringcontentListEntryIdentifier, EntryDeleteParams { zone_id } params, RequestOptionsoptions?): EntryDeleteResponse { id } | null
DELETE/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
ModelsExpand Collapse
EntryListResponse { entries }
entries?: Array<Entry>

Provides content list entries.

id?: string

Specify the identifier of the hostname.

maxLength32
content?: string

Specify the CID or content path of content to block.

maxLength500
created_on?: string
formatdate-time
description?: string

Specify an optional description of the content list entry.

maxLength500
modified_on?: string
formatdate-time
type?: "cid" | "content_path"

Specify the type of content list entry to block.

One of the following:
"cid"
"content_path"
EntryGetResponse { id, content, created_on, 3 more }

Specify a content list entry to block.

id?: string

Specify the identifier of the hostname.

maxLength32
content?: string

Specify the CID or content path of content to block.

maxLength500
created_on?: string
formatdate-time
description?: string

Specify an optional description of the content list entry.

maxLength500
modified_on?: string
formatdate-time
type?: "cid" | "content_path"

Specify the type of content list entry to block.

One of the following:
"cid"
"content_path"
EntryCreateResponse { id, content, created_on, 3 more }

Specify a content list entry to block.

id?: string

Specify the identifier of the hostname.

maxLength32
content?: string

Specify the CID or content path of content to block.

maxLength500
created_on?: string
formatdate-time
description?: string

Specify an optional description of the content list entry.

maxLength500
modified_on?: string
formatdate-time
type?: "cid" | "content_path"

Specify the type of content list entry to block.

One of the following:
"cid"
"content_path"
EntryUpdateResponse { id, content, created_on, 3 more }

Specify a content list entry to block.

id?: string

Specify the identifier of the hostname.

maxLength32
content?: string

Specify the CID or content path of content to block.

maxLength500
created_on?: string
formatdate-time
description?: string

Specify an optional description of the content list entry.

maxLength500
modified_on?: string
formatdate-time
type?: "cid" | "content_path"

Specify the type of content list entry to block.

One of the following:
"cid"
"content_path"
EntryDeleteResponse { id }
id: string

Specify the identifier of the hostname.

maxLength32