---
title: Web3
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Web3

#### Web3Hostnames

##### [List Web3 Hostnames](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/methods/list)

web3.hostnames.list(HostnameListParams\*\*kwargs) -> SyncSinglePage\[[Hostname](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>)]

GET/zones/{zone\_id}/web3/hostnames

##### [Web3 Hostname Details](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/methods/get)

web3.hostnames.get(stridentifier, HostnameGetParams\*\*kwargs) -> [Hostname](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>)

GET/zones/{zone\_id}/web3/hostnames/{identifier}

##### [Create Web3 Hostname](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/methods/create)

web3.hostnames.create(HostnameCreateParams\*\*kwargs) -> [Hostname](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>)

POST/zones/{zone\_id}/web3/hostnames

##### [Edit Web3 Hostname](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/methods/edit)

web3.hostnames.edit(stridentifier, HostnameEditParams\*\*kwargs) -> [Hostname](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>)

PATCH/zones/{zone\_id}/web3/hostnames/{identifier}

##### [Delete Web3 Hostname](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/methods/delete)

web3.hostnames.delete(stridentifier, HostnameDeleteParams\*\*kwargs) -> [HostnameDeleteResponse](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname_delete_response%20%3E%20(schema)>)

DELETE/zones/{zone\_id}/web3/hostnames/{identifier}

##### ModelsExpand Collapse

<details>

<summary>

class Hostname: …

</summary>

id: Optional\[str]

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

created\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

description: Optional\[str]

Specify an optional description of the hostname.

maxLength500

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20description">Link to this property</a>

dnslink: Optional\[str]

Specify the DNSLink value used if the target is ipfs.

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20dnslink">Link to this property</a>

modified\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

name: Optional\[str]

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

maxLength255

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

<details>

<summary>

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

Specifies the status of the hostname’s activation.

</summary>

One of the following:

"active"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

"pending"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

"deleting"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%202">Link to this property</a>

"error"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

<details>

<summary>

target: Optional\[Literal\["ethereum", "ipfs", "ipfs\_universal\_path"]]

Specify the target gateway of the hostname.

</summary>

One of the following:

"ethereum"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20target%20%3E%20(member)%200">Link to this property</a>

"ipfs"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20target%20%3E%20(member)%201">Link to this property</a>

"ipfs\_universal\_path"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20target%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20target">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>)

<details>

<summary>

class HostnameDeleteResponse: …

</summary>

id: str

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames%20%3E%20(model)%20hostname_delete_response%20%3E%20(schema)>)

#### Web3HostnamesIPFS Universal Paths

#### Web3HostnamesIPFS Universal PathsContent Lists

##### [IPFS Universal Path Gateway Content List Details](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/methods/get)

web3.hostnames.ipfs\_universal\_paths.content\_lists.get(stridentifier, ContentListGetParams\*\*kwargs) -> [ContentList](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists%20%3E%20(model)%20content_list%20%3E%20(schema)>)

GET/zones/{zone\_id}/web3/hostnames/{identifier}/ipfs\_universal\_path/content\_list

##### [Update IPFS Universal Path Gateway Content List](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/methods/update)

web3.hostnames.ipfs\_universal\_paths.content\_lists.update(stridentifier, ContentListUpdateParams\*\*kwargs) -> [ContentList](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists%20%3E%20(model)%20content_list%20%3E%20(schema)>)

PUT/zones/{zone\_id}/web3/hostnames/{identifier}/ipfs\_universal\_path/content\_list

##### ModelsExpand Collapse

<details>

<summary>

class ContentList: …

</summary>

action: Optional\[Literal\["block"]]

Behavior of the content list.

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists%20%3E%20(model)%20content_list%20%3E%20(schema)%20%3E%20(property)%20action">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists%20%3E%20(model)%20content_list%20%3E%20(schema)>)

#### Web3HostnamesIPFS Universal PathsContent ListsEntries

##### [List IPFS Universal Path Gateway Content List Entries](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/list)

web3.hostnames.ipfs\_universal\_paths.content\_lists.entries.list(stridentifier, EntryListParams\*\*kwargs) -> [EntryListResponse](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/web3/hostnames/{identifier}/ipfs\_universal\_path/content\_list/entries

##### [IPFS Universal Path Gateway Content List Entry Details](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/get)

web3.hostnames.ipfs\_universal\_paths.content\_lists.entries.get(strcontent\_list\_entry\_identifier, EntryGetParams\*\*kwargs) -> [EntryGetResponse](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)>)

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](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/create)

web3.hostnames.ipfs\_universal\_paths.content\_lists.entries.create(stridentifier, EntryCreateParams\*\*kwargs) -> [EntryCreateResponse](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/web3/hostnames/{identifier}/ipfs\_universal\_path/content\_list/entries

##### [Edit IPFS Universal Path Gateway Content List Entry](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/update)

web3.hostnames.ipfs\_universal\_paths.content\_lists.entries.update(strcontent\_list\_entry\_identifier, EntryUpdateParams\*\*kwargs) -> [EntryUpdateResponse](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)>)

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](https://developers.cloudflare.com/api/python/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/delete)

web3.hostnames.ipfs\_universal\_paths.content\_lists.entries.delete(strcontent\_list\_entry\_identifier, EntryDeleteParams\*\*kwargs) -> [EntryDeleteResponse](<https://developers.cloudflare.com/api/python/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_delete_response%20%3E%20(schema)>)

DELETE/zones/{zone\_id}/web3/hostnames/{identifier}/ipfs\_universal\_path/content\_list/entries/{content\_list\_entry\_identifier}

##### ModelsExpand Collapse

<details>

<summary>

class EntryListResponse: …

</summary>

<details>

<summary>

entries: Optional\[List\[Entry]]

Provides content list entries.

</summary>

id: Optional\[str]

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

content: Optional\[str]

Specify the CID or content path of content to block.

maxLength500

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries%20%3E%20(items)%20%3E%20(property)%20content">Link to this property</a>

created\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries%20%3E%20(items)%20%3E%20(property)%20created_on">Link to this property</a>

description: Optional\[str]

Specify an optional description of the content list entry.

maxLength500

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries%20%3E%20(items)%20%3E%20(property)%20description">Link to this property</a>

modified\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries%20%3E%20(items)%20%3E%20(property)%20modified_on">Link to this property</a>

<details>

<summary>

type: Optional\[Literal\["cid", "content\_path"]]

Specify the type of content list entry to block.

</summary>

One of the following:

"cid"

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"content\_path"

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries%20%3E%20(items)%20%3E%20(property)%20type">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)%20%3E%20(property)%20entries">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_list_response%20%3E%20(schema)>)

<details>

<summary>

class EntryGetResponse: …

Specify a content list entry to block.

</summary>

id: Optional\[str]

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

content: Optional\[str]

Specify the CID or content path of content to block.

maxLength500

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)%20%3E%20(property)%20content">Link to this property</a>

created\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

description: Optional\[str]

Specify an optional description of the content list entry.

maxLength500

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)%20%3E%20(property)%20description">Link to this property</a>

modified\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

<details>

<summary>

type: Optional\[Literal\["cid", "content\_path"]]

Specify the type of content list entry to block.

</summary>

One of the following:

"cid"

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"content\_path"

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)%20%3E%20(property)%20type">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_get_response%20%3E%20(schema)>)

<details>

<summary>

class EntryCreateResponse: …

Specify a content list entry to block.

</summary>

id: Optional\[str]

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

content: Optional\[str]

Specify the CID or content path of content to block.

maxLength500

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)%20%3E%20(property)%20content">Link to this property</a>

created\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

description: Optional\[str]

Specify an optional description of the content list entry.

maxLength500

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)%20%3E%20(property)%20description">Link to this property</a>

modified\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

<details>

<summary>

type: Optional\[Literal\["cid", "content\_path"]]

Specify the type of content list entry to block.

</summary>

One of the following:

"cid"

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"content\_path"

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)%20%3E%20(property)%20type">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_create_response%20%3E%20(schema)>)

<details>

<summary>

class EntryUpdateResponse: …

Specify a content list entry to block.

</summary>

id: Optional\[str]

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

content: Optional\[str]

Specify the CID or content path of content to block.

maxLength500

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)%20%3E%20(property)%20content">Link to this property</a>

created\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

description: Optional\[str]

Specify an optional description of the content list entry.

maxLength500

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)%20%3E%20(property)%20description">Link to this property</a>

modified\_on: Optional\[datetime]

formatdate-time

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

<details>

<summary>

type: Optional\[Literal\["cid", "content\_path"]]

Specify the type of content list entry to block.

</summary>

One of the following:

"cid"

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"content\_path"

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)%20%3E%20(property)%20type">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_update_response%20%3E%20(schema)>)

<details>

<summary>

class EntryDeleteResponse: …

</summary>

id: str

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20entry_delete_response%20%3E%20(schema)>)