Skip to content
Cloudflare API
Start here
API Reference
Web3
Hostnames

Create Web3 Hostname

web3.hostnames.create(HostnameCreateParams**kwargs) -> Hostname
POST/zones/{zone_id}/web3/hostnames

Create Web3 Hostname

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Web3 Hostnames Write
ParametersExpand Collapse
zone_id: str

Specify the identifier of the hostname.

maxLength32
name: str

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

maxLength255
target: Literal["ethereum", "ipfs", "ipfs_universal_path"]

Specify the target gateway of the hostname.

One of the following:
"ethereum"
"ipfs"
"ipfs_universal_path"
description: Optional[str]

Specify an optional description of the hostname.

maxLength500
ReturnsExpand Collapse
class Hostname: …
id: Optional[str]

Specify the identifier of the hostname.

maxLength32
created_on: Optional[datetime]
formatdate-time
description: Optional[str]

Specify an optional description of the hostname.

maxLength500
modified_on: Optional[datetime]
formatdate-time
name: Optional[str]

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

maxLength255
status: Optional[Literal["active", "pending", "deleting", "error"]]

Specifies the status of the hostname's activation.

One of the following:
"active"
"pending"
"deleting"
"error"
target: Optional[Literal["ethereum", "ipfs", "ipfs_universal_path"]]

Specify the target gateway of the hostname.

One of the following:
"ethereum"
"ipfs"
"ipfs_universal_path"

Create Web3 Hostname

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
hostname = client.web3.hostnames.create(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    name="gateway.example.com",
    target="ipfs",
)
print(hostname.id)
{
  "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": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "This is my IPFS gateway.",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "gateway.example.com",
    "status": "active",
    "target": "ipfs"
  },
  "success": true,
  "result_info": {}
}
Returns Examples
{
  "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": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "This is my IPFS gateway.",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "gateway.example.com",
    "status": "active",
    "target": "ipfs"
  },
  "success": true,
  "result_info": {}
}