--- title: Hostnames --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Web3](https://developers.cloudflare.com/api/typescript/resources/web3) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Hostnames ##### [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]() {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]() {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]() {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]() {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]() {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 Link to this property created\_on?: string formatdate-time Link to this property description?: string Specify an optional description of the hostname. maxLength500 Link to this property dnslink?: string Specify the DNSLink value used if the target is ipfs. Link to this property modified\_on?: string formatdate-time Link to this property name?: string Specify the hostname that points to the target gateway via CNAME. maxLength255 Link to this property

status?: "active"| "pending"| "deleting"| "error" Specifies the status of the hostname’s activation.

One of the following: "active" Link to this property "pending" Link to this property "deleting" Link to this property "error" Link to this property

Link to this property

target?: "ethereum"| "ipfs"| "ipfs\_universal\_path" Specify the target gateway of the hostname.

One of the following: "ethereum" Link to this property "ipfs" Link to this property "ipfs\_universal\_path" Link to this property

Link to this property

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

HostnameDeleteResponse {id }

id: string Specify the identifier of the hostname. maxLength32 Link to this property

[Link to this property](<#(resource)%20web3.hostnames%20%3E%20(model)%20hostname_delete_response%20%3E%20(schema)>) #### HostnamesIPFS Universal Paths #### HostnamesIPFS Universal PathsContent Lists ##### [IPFS Universal Path Gateway Content List Details](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/methods/update) 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. Link to this property

[Link to this property](<#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists%20%3E%20(model)%20content_list%20%3E%20(schema)>) #### HostnamesIPFS Universal PathsContent ListsEntries ##### [List IPFS Universal Path Gateway Content List Entries](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/get) client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.get(stringcontentListEntryIdentifier, EntryGetParams {zone\_id, identifier } 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/update) client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.update(stringcontentListEntryIdentifier, EntryUpdateParams {zone\_id, identifier, content, 2 more } 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](https://developers.cloudflare.com/api/typescript/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/delete) client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.delete(stringcontentListEntryIdentifier, EntryDeleteParams {zone\_id, identifier } 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 Link to this property content?: string Specify the CID or content path of content to block. maxLength500 Link to this property created\_on?: string formatdate-time Link to this property description?: string Specify an optional description of the content list entry. maxLength500 Link to this property modified\_on?: string formatdate-time Link to this property

type?: "cid"| "content\_path" Specify the type of content list entry to block.

One of the following: "cid" Link to this property "content\_path" Link to this property

Link to this property

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

EntryGetResponse {id, content, created\_on, 3 more } Specify a content list entry to block.

type?: "cid"| "content\_path" Specify the type of content list entry to block.

One of the following: "cid" Link to this property "content\_path" Link to this property

Link to this property

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

EntryCreateResponse {id, content, created\_on, 3 more } Specify a content list entry to block.

type?: "cid"| "content\_path" Specify the type of content list entry to block.

One of the following: "cid" Link to this property "content\_path" Link to this property

Link to this property

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

EntryUpdateResponse {id, content, created\_on, 3 more } Specify a content list entry to block.

type?: "cid"| "content\_path" Specify the type of content list entry to block.

One of the following: "cid" Link to this property "content\_path" Link to this property

Link to this property

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

EntryDeleteResponse {id }

id: string Specify the identifier of the hostname. maxLength32 Link to this property

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