---
title: Web3
---

[Skip to content](#%5Ftop) 

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

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/typescript/resources/web3/subresources/hostnames/methods/list)

client.web3.hostnames.list(HostnameListParams { zone\_id } params, RequestOptionsoptions?): SinglePage<[Hostname](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames%20%3E%20%28model%29%20hostname%20%3E%20%28schema%29) { id, created\_on, description, 5 more } \>

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

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

client.web3.hostnames.get(stringidentifier, HostnameGetParams { zone\_id } params, RequestOptionsoptions?): [Hostname](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames%20%3E%20%28model%29%20hostname%20%3E%20%28schema%29) { id, created\_on, description, 5 more } 

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

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

client.web3.hostnames.create(HostnameCreateParams { zone\_id, name, target, 2 more } params, RequestOptionsoptions?): [Hostname](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames%20%3E%20%28model%29%20hostname%20%3E%20%28schema%29) { id, created\_on, description, 5 more } 

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

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

client.web3.hostnames.edit(stringidentifier, HostnameEditParams { zone\_id, description, dnslink } params, RequestOptionsoptions?): [Hostname](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames%20%3E%20%28model%29%20hostname%20%3E%20%28schema%29) { id, created\_on, description, 5 more } 

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

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

client.web3.hostnames.delete(stringidentifier, HostnameDeleteParams { zone\_id } params, RequestOptionsoptions?): [HostnameDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames%20%3E%20%28model%29%20hostname%5Fdelete%5Fresponse%20%3E%20%28schema%29) { 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

dnslink?: string

Specify the DNSLink value used if the target is ipfs.

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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs%5Funiversal%5Fpaths/subresources/content%5Flists/methods/get)

client.web3.hostnames.ipfsUniversalPaths.contentLists.get(stringidentifier, ContentListGetParams { zone\_id } params, RequestOptionsoptions?): [ContentList](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames.ipfs%5Funiversal%5Fpaths.content%5Flists%20%3E%20%28model%29%20content%5Flist%20%3E%20%28schema%29) { action } 

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

##### [Update IPFS Universal Path Gateway Content List](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs%5Funiversal%5Fpaths/subresources/content%5Flists/methods/update)

client.web3.hostnames.ipfsUniversalPaths.contentLists.update(stringidentifier, ContentListUpdateParams { zone\_id, action, entries } params, RequestOptionsoptions?): [ContentList](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames.ipfs%5Funiversal%5Fpaths.content%5Flists%20%3E%20%28model%29%20content%5Flist%20%3E%20%28schema%29) { 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs%5Funiversal%5Fpaths/subresources/content%5Flists/subresources/entries/methods/list)

client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.list(stringidentifier, EntryListParams { zone\_id } params, RequestOptionsoptions?): [EntryListResponse](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames.ipfs%5Funiversal%5Fpaths.content%5Flists.entries%20%3E%20%28model%29%20entry%5Flist%5Fresponse%20%3E%20%28schema%29) { entries } | null

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/typescript/resources/web3/subresources/hostnames/subresources/ipfs%5Funiversal%5Fpaths/subresources/content%5Flists/subresources/entries/methods/get)

client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.get(stringcontentListEntryIdentifier, EntryGetParams { zone\_id, identifier } params, RequestOptionsoptions?): [EntryGetResponse](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames.ipfs%5Funiversal%5Fpaths.content%5Flists.entries%20%3E%20%28model%29%20entry%5Fget%5Fresponse%20%3E%20%28schema%29) { 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs%5Funiversal%5Fpaths/subresources/content%5Flists/subresources/entries/methods/create)

client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.create(stringidentifier, EntryCreateParams { zone\_id, content, type, description } params, RequestOptionsoptions?): [EntryCreateResponse](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames.ipfs%5Funiversal%5Fpaths.content%5Flists.entries%20%3E%20%28model%29%20entry%5Fcreate%5Fresponse%20%3E%20%28schema%29) { 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs%5Funiversal%5Fpaths/subresources/content%5Flists/subresources/entries/methods/update)

client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.update(stringcontentListEntryIdentifier, EntryUpdateParams { zone\_id, identifier, content, 2 more } params, RequestOptionsoptions?): [EntryUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames.ipfs%5Funiversal%5Fpaths.content%5Flists.entries%20%3E%20%28model%29%20entry%5Fupdate%5Fresponse%20%3E%20%28schema%29) { 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs%5Funiversal%5Fpaths/subresources/content%5Flists/subresources/entries/methods/delete)

client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.delete(stringcontentListEntryIdentifier, EntryDeleteParams { zone\_id, identifier } params, RequestOptionsoptions?): [EntryDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/web3#%28resource%29%20web3.hostnames.ipfs%5Funiversal%5Fpaths.content%5Flists.entries%20%3E%20%28model%29%20entry%5Fdelete%5Fresponse%20%3E%20%28schema%29) { 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