Create Web3 Hostname

client.Web3.Hostnames.New(ctx, params) (*Hostname, error)

POST/zones/{zone_id}/web3/hostnames

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

params HostnameNewParams

ZoneID param.Field[string]

Path param: Specify the identifier of the hostname.

maxLength32

Name param.Field[string]

Body param: Specify the hostname that points to the target gateway via CNAME.

maxLength255

Target param.Field[HostnameNewParamsTarget]

Body param: Specify the target gateway of the hostname.

const HostnameNewParamsTargetEthereum HostnameNewParamsTarget = "ethereum"

const HostnameNewParamsTargetIPFS HostnameNewParamsTarget = "ipfs"

const HostnameNewParamsTargetIPFSUniversalPath HostnameNewParamsTarget = "ipfs_universal_path"

Description param.Field[string]optional

Body param: Specify an optional description of the hostname.

maxLength500

Dnslink param.Field[string]optional

Body param: Specify the DNSLink value used if the target is ipfs.

ReturnsExpand 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

Dnslink stringoptional

Specify the DNSLink value used if the target is ipfs.

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"

Create Web3 Hostname

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/web3"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  hostname, err := client.Web3.Hostnames.New(context.TODO(), web3.HostnameNewParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Name: cloudflare.F("gateway.example.com"),
    Target: cloudflare.F(web3.HostnameNewParamsTargetIPFS),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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": {}
}