---
title: Hostnames
---

[Skip to content](#_top)

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

[Web3](https://developers.cloudflare.com/api/go/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/go/resources/web3/subresources/hostnames/methods/list)

client.Web3.Hostnames.List(ctx, query) (\*SinglePage\[[Hostname](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>)], error)

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

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

client.Web3.Hostnames.Get(ctx, identifier, query) (\*[Hostname](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>), error)

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

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

client.Web3.Hostnames.New(ctx, params) (\*[Hostname](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>), error)

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

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

client.Web3.Hostnames.Edit(ctx, identifier, params) (\*[Hostname](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>), error)

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

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

client.Web3.Hostnames.Delete(ctx, identifier, body) (\*[HostnameDeleteResponse](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20HostnameDeleteResponse%20%3E%20(schema)>), error)

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

##### ModelsExpand Collapse

<details>

<summary>

type Hostname struct{…}

</summary>

ID stringOptional

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>

CreatedOn TimeOptional

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 stringOptional

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 stringOptional

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>

ModifiedOn TimeOptional

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 stringOptional

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 HostnameStatusOptional

Specifies the status of the hostname’s activation.

</summary>

One of the following:

const HostnameStatusActive HostnameStatus = "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>

const HostnameStatusPending HostnameStatus = "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>

const HostnameStatusDeleting HostnameStatus = "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>

const HostnameStatusError HostnameStatus = "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 HostnameTargetOptional

Specify the target gateway of the hostname.

</summary>

One of the following:

const HostnameTargetEthereum HostnameTarget = "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>

const HostnameTargetIPFS HostnameTarget = "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>

const HostnameTargetIPFSUniversalPath HostnameTarget = "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)>)

#### HostnamesIPFS Universal Paths

#### HostnamesIPFS Universal PathsContent Lists

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

client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Get(ctx, identifier, query) (\*[ContentList](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists%20%3E%20(model)%20content_list%20%3E%20(schema)>), error)

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

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

client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Update(ctx, identifier, params) (\*[ContentList](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists%20%3E%20(model)%20content_list%20%3E%20(schema)>), error)

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

##### ModelsExpand Collapse

<details>

<summary>

type ContentList struct{…}

</summary>

Action ContentListActionOptional

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)>)

#### HostnamesIPFS Universal PathsContent ListsEntries

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

client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.List(ctx, identifier, query) (\*[HostnameIPFSUniversalPathContentListEntryListResponse](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20HostnameIPFSUniversalPathContentListEntryListResponse%20%3E%20(schema)>), error)

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/go/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/get)

client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.Get(ctx, identifier, contentListEntryIdentifier, query) (\*[HostnameIPFSUniversalPathContentListEntryGetResponse](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20HostnameIPFSUniversalPathContentListEntryGetResponse%20%3E%20(schema)>), error)

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/go/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/create)

client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.New(ctx, identifier, params) (\*[HostnameIPFSUniversalPathContentListEntryNewResponse](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20HostnameIPFSUniversalPathContentListEntryNewResponse%20%3E%20(schema)>), error)

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/go/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/update)

client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.Update(ctx, identifier, contentListEntryIdentifier, params) (\*[HostnameIPFSUniversalPathContentListEntryUpdateResponse](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20HostnameIPFSUniversalPathContentListEntryUpdateResponse%20%3E%20(schema)>), error)

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/go/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/delete)

client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.Delete(ctx, identifier, contentListEntryIdentifier, body) (\*[HostnameIPFSUniversalPathContentListEntryDeleteResponse](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames.ipfs_universal_paths.content_lists.entries%20%3E%20(model)%20HostnameIPFSUniversalPathContentListEntryDeleteResponse%20%3E%20(schema)>), error)

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