Skip to content
Cloudflare API
Start here
API Reference
Web3

Hostnames

List Web3 Hostnames
client.Web3.Hostnames.List(ctx, query) (*SinglePage[Hostname], error)
GET/zones/{zone_id}/web3/hostnames
Web3 Hostname Details
client.Web3.Hostnames.Get(ctx, identifier, query) (*Hostname, error)
GET/zones/{zone_id}/web3/hostnames/{identifier}
Create Web3 Hostname
client.Web3.Hostnames.New(ctx, params) (*Hostname, error)
POST/zones/{zone_id}/web3/hostnames
Edit Web3 Hostname
client.Web3.Hostnames.Edit(ctx, identifier, params) (*Hostname, error)
PATCH/zones/{zone_id}/web3/hostnames/{identifier}
Delete Web3 Hostname
client.Web3.Hostnames.Delete(ctx, identifier, body) (*HostnameDeleteResponse, error)
DELETE/zones/{zone_id}/web3/hostnames/{identifier}
ModelsExpand Collapse
type Hostname struct{…}
ID stringoptional

Specify the identifier of the hostname.

maxLength32
CreatedOn Timeoptional
formatdate-time
Description stringoptional

Specify an optional description of the hostname.

maxLength500
ModifiedOn Timeoptional
formatdate-time
Name stringoptional

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

maxLength255
Status HostnameStatusoptional

Specifies the status of the hostname's activation.

One of the following:
const HostnameStatusActive HostnameStatus = "active"
const HostnameStatusPending HostnameStatus = "pending"
const HostnameStatusDeleting HostnameStatus = "deleting"
const HostnameStatusError HostnameStatus = "error"
Target HostnameTargetoptional

Specify the target gateway of the hostname.

One of the following:
const HostnameTargetEthereum HostnameTarget = "ethereum"
const HostnameTargetIPFS HostnameTarget = "ipfs"
const HostnameTargetIPFSUniversalPath HostnameTarget = "ipfs_universal_path"

HostnamesIPFS Universal Paths

HostnamesIPFS Universal PathsContent Lists

IPFS Universal Path Gateway Content List Details
client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Get(ctx, identifier, query) (*ContentList, error)
GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list
Update IPFS Universal Path Gateway Content List
client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Update(ctx, identifier, params) (*ContentList, error)
PUT/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list
ModelsExpand Collapse
type ContentList struct{…}
Action ContentListActionoptional

Behavior of the content list.

HostnamesIPFS Universal PathsContent ListsEntries

List IPFS Universal Path Gateway Content List Entries
client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.List(ctx, identifier, query) (*HostnameIPFSUniversalPathContentListEntryListResponse, error)
GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries
IPFS Universal Path Gateway Content List Entry Details
client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.Get(ctx, identifier, contentListEntryIdentifier, query) (*HostnameIPFSUniversalPathContentListEntryGetResponse, 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
client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.New(ctx, identifier, params) (*HostnameIPFSUniversalPathContentListEntryNewResponse, error)
POST/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries
Edit IPFS Universal Path Gateway Content List Entry
client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.Update(ctx, identifier, contentListEntryIdentifier, params) (*HostnameIPFSUniversalPathContentListEntryUpdateResponse, 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
client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.Delete(ctx, identifier, contentListEntryIdentifier, body) (*HostnameIPFSUniversalPathContentListEntryDeleteResponse, error)
DELETE/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}