Cloudflare API | Web3 › Hostnames

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/web3/hostnames/$IDENTIFIER \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "description": "This is my IPFS gateway.",
      "dnslink": "/ipns/onboarding.ipfs.cloudflare.com"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "description": "This is my IPFS gateway.",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
    "name": "gateway.example.com",
    "target": "ipfs"
  },
  "success": true,
  "result_info": {}
}

Web3 Hostname Details -> Envelope<

Hostname

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

Web3 Hostname Details

List Web3 Hostnames -> SinglePage<

Hostname

get/zones/{zone_id}/web3/hostnames

List Web3 Hostnames

Domain types

Hostname = { id, created_on, description, 5 more... }

Web3 Hostnames

IPFS Universal Paths

web3.hostnames.ipfs_universal_paths

Web3 Hostnames IPFS Universal Paths

Content Lists

web3.hostnames.ipfs_universal_paths.content_lists

Methods

IPFS Universal Path Gateway Content List Details -> Envelope<

ContentList

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

IPFS Universal Path Gateway Content List Details

Update IPFS Universal Path Gateway Content List -> Envelope<

ContentList

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

Update IPFS Universal Path Gateway Content List

Domain types

ContentList = { action }

Web3 Hostnames IPFS Universal Paths Content Lists

Entries

web3.hostnames.ipfs_universal_paths.content_lists.entries

Methods

Create IPFS Universal Path Gateway Content List Entry -> Envelope<{ id, content, created_on, 3 more... }>

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

Create IPFS Universal Path Gateway Content List Entry

Delete IPFS Universal Path Gateway Content List Entry -> Envelope<{ id }>

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

Delete IPFS Universal Path Gateway Content List Entry

IPFS Universal Path Gateway Content List Entry Details -> Envelope<{ id, content, created_on, 3 more... }>

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

IPFS Universal Path Gateway Content List Entry Details

List IPFS Universal Path Gateway Content List Entries -> Envelope<{ entries }>

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

List IPFS Universal Path Gateway Content List Entries

Edit IPFS Universal Path Gateway Content List Entry -> Envelope<{ id, content, created_on, 3 more... }>

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

Edit IPFS Universal Path Gateway Content List Entry