Hostnames

List Web3 Hostnames

GET/zones/{zone_id}/web3/hostnames

Web3 Hostname Details

GET/zones/{zone_id}/web3/hostnames/{identifier}

Create Web3 Hostname

POST/zones/{zone_id}/web3/hostnames

Edit Web3 Hostname

PATCH/zones/{zone_id}/web3/hostnames/{identifier}

Delete Web3 Hostname

DELETE/zones/{zone_id}/web3/hostnames/{identifier}

ModelsExpand Collapse

Hostname { id, created_on, description, 5 more }

id: optional string

Specify the identifier of the hostname.

maxLength32

created_on: optional string

formatdate-time

description: optional string

Specify an optional description of the hostname.

maxLength500

dnslink: optional string

Specify the DNSLink value used if the target is ipfs.

modified_on: optional string

formatdate-time

name: optional string

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

maxLength255

status: optional "active" or "pending" or "deleting" or "error"

Specifies the status of the hostname’s activation.

One of the following:

"active"

"pending"

"deleting"

"error"

target: optional "ethereum" or "ipfs" or "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

HostnamesIPFS Universal Paths

HostnamesIPFS Universal PathsContent Lists

IPFS Universal Path Gateway Content List Details

GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list

Update IPFS Universal Path Gateway Content List

PUT/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list

ModelsExpand Collapse

ContentList { action }

action: optional "block"

Behavior of the content list.

HostnamesIPFS Universal PathsContent ListsEntries

List IPFS Universal Path Gateway Content List Entries

GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries

IPFS Universal Path Gateway Content List Entry Details

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

POST/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries

Edit IPFS Universal Path Gateway Content List Entry

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

DELETE/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}

ModelsExpand Collapse

EntryListResponse { entries }

entries: optional array of { id, content, created_on, 3 more }

Provides content list entries.

id: optional string

Specify the identifier of the hostname.

maxLength32

content: optional string

Specify the CID or content path of content to block.

maxLength500

created_on: optional string

formatdate-time

description: optional string

Specify an optional description of the content list entry.

maxLength500

modified_on: optional string

formatdate-time

type: optional "cid" or "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: optional string

Specify the identifier of the hostname.

maxLength32

content: optional string

Specify the CID or content path of content to block.

maxLength500

created_on: optional string

formatdate-time

description: optional string

Specify an optional description of the content list entry.

maxLength500

modified_on: optional string

formatdate-time

type: optional "cid" or "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: optional string

Specify the identifier of the hostname.

maxLength32

content: optional string

Specify the CID or content path of content to block.

maxLength500

created_on: optional string

formatdate-time

description: optional string

Specify an optional description of the content list entry.

maxLength500

modified_on: optional string

formatdate-time

type: optional "cid" or "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: optional string

Specify the identifier of the hostname.

maxLength32

content: optional string

Specify the CID or content path of content to block.

maxLength500

created_on: optional string

formatdate-time

description: optional string

Specify an optional description of the content list entry.

maxLength500

modified_on: optional string

formatdate-time

type: optional "cid" or "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