Skip to content
Cloudflare API
Start here
API Reference

Web3

Web3Hostnames

List Web3 Hostnames
web3.hostnames.list(HostnameListParams**kwargs) -> SyncSinglePage[Hostname]
GET/zones/{zone_id}/web3/hostnames
Web3 Hostname Details
web3.hostnames.get(stridentifier, HostnameGetParams**kwargs) -> Hostname
GET/zones/{zone_id}/web3/hostnames/{identifier}
Create Web3 Hostname
web3.hostnames.create(HostnameCreateParams**kwargs) -> Hostname
POST/zones/{zone_id}/web3/hostnames
Edit Web3 Hostname
web3.hostnames.edit(stridentifier, HostnameEditParams**kwargs) -> Hostname
PATCH/zones/{zone_id}/web3/hostnames/{identifier}
Delete Web3 Hostname
web3.hostnames.delete(stridentifier, HostnameDeleteParams**kwargs) -> HostnameDeleteResponse
DELETE/zones/{zone_id}/web3/hostnames/{identifier}
ModelsExpand Collapse
class Hostname: …
id: Optional[str]

Specify the identifier of the hostname.

maxLength32
created_on: Optional[datetime]
formatdate-time
description: Optional[str]

Specify an optional description of the hostname.

maxLength500
modified_on: Optional[datetime]
formatdate-time
name: Optional[str]

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

maxLength255
status: Optional[Literal["active", "pending", "deleting", "error"]]

Specifies the status of the hostname's activation.

One of the following:
"active"
"pending"
"deleting"
"error"
target: Optional[Literal["ethereum", "ipfs", "ipfs_universal_path"]]

Specify the target gateway of the hostname.

One of the following:
"ethereum"
"ipfs"
"ipfs_universal_path"
class HostnameDeleteResponse: …
id: str

Specify the identifier of the hostname.

maxLength32

Web3HostnamesIPFS Universal Paths

Web3HostnamesIPFS Universal PathsContent Lists

IPFS Universal Path Gateway Content List Details
web3.hostnames.ipfs_universal_paths.content_lists.get(stridentifier, ContentListGetParams**kwargs) -> ContentList
GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list
Update IPFS Universal Path Gateway Content List
web3.hostnames.ipfs_universal_paths.content_lists.update(stridentifier, ContentListUpdateParams**kwargs) -> ContentList
PUT/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list
ModelsExpand Collapse
class ContentList: …
action: Optional[Literal["block"]]

Behavior of the content list.

Web3HostnamesIPFS Universal PathsContent ListsEntries

List IPFS Universal Path Gateway Content List Entries
web3.hostnames.ipfs_universal_paths.content_lists.entries.list(stridentifier, EntryListParams**kwargs) -> EntryListResponse
GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries
IPFS Universal Path Gateway Content List Entry Details
web3.hostnames.ipfs_universal_paths.content_lists.entries.get(strcontent_list_entry_identifier, EntryGetParams**kwargs) -> EntryGetResponse
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
web3.hostnames.ipfs_universal_paths.content_lists.entries.create(stridentifier, EntryCreateParams**kwargs) -> EntryCreateResponse
POST/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries
Edit IPFS Universal Path Gateway Content List Entry
web3.hostnames.ipfs_universal_paths.content_lists.entries.update(strcontent_list_entry_identifier, EntryUpdateParams**kwargs) -> EntryUpdateResponse
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
web3.hostnames.ipfs_universal_paths.content_lists.entries.delete(strcontent_list_entry_identifier, EntryDeleteParams**kwargs) -> EntryDeleteResponse
DELETE/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
ModelsExpand Collapse
class EntryListResponse: …
entries: Optional[List[Entry]]

Provides content list entries.

id: Optional[str]

Specify the identifier of the hostname.

maxLength32
content: Optional[str]

Specify the CID or content path of content to block.

maxLength500
created_on: Optional[datetime]
formatdate-time
description: Optional[str]

Specify an optional description of the content list entry.

maxLength500
modified_on: Optional[datetime]
formatdate-time
type: Optional[Literal["cid", "content_path"]]

Specify the type of content list entry to block.

One of the following:
"cid"
"content_path"
class EntryGetResponse: …

Specify a content list entry to block.

id: Optional[str]

Specify the identifier of the hostname.

maxLength32
content: Optional[str]

Specify the CID or content path of content to block.

maxLength500
created_on: Optional[datetime]
formatdate-time
description: Optional[str]

Specify an optional description of the content list entry.

maxLength500
modified_on: Optional[datetime]
formatdate-time
type: Optional[Literal["cid", "content_path"]]

Specify the type of content list entry to block.

One of the following:
"cid"
"content_path"
class EntryCreateResponse: …

Specify a content list entry to block.

id: Optional[str]

Specify the identifier of the hostname.

maxLength32
content: Optional[str]

Specify the CID or content path of content to block.

maxLength500
created_on: Optional[datetime]
formatdate-time
description: Optional[str]

Specify an optional description of the content list entry.

maxLength500
modified_on: Optional[datetime]
formatdate-time
type: Optional[Literal["cid", "content_path"]]

Specify the type of content list entry to block.

One of the following:
"cid"
"content_path"
class EntryUpdateResponse: …

Specify a content list entry to block.

id: Optional[str]

Specify the identifier of the hostname.

maxLength32
content: Optional[str]

Specify the CID or content path of content to block.

maxLength500
created_on: Optional[datetime]
formatdate-time
description: Optional[str]

Specify an optional description of the content list entry.

maxLength500
modified_on: Optional[datetime]
formatdate-time
type: Optional[Literal["cid", "content_path"]]

Specify the type of content list entry to block.

One of the following:
"cid"
"content_path"
class EntryDeleteResponse: …
id: str

Specify the identifier of the hostname.

maxLength32