---
title: List Web3 Hostnames
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

[Web3](https://developers.cloudflare.com/api/go/resources/web3)

[Hostnames](https://developers.cloudflare.com/api/go/resources/web3/subresources/hostnames)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# List Web3 Hostnames

client.Web3.Hostnames.List(ctx, query) (\*SinglePage\[[Hostname](<https://developers.cloudflare.com/api/go/resources/web3#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>)], error)

GET/zones/{zone\_id}/web3/hostnames

List Web3 Hostnames

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



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

**Example:**<code>X-Auth-Email: user@example.com</code>

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

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Web3 Hostnames Write``Web3 Hostnames Read`

##### ParametersExpand Collapse

<details>

<summary>

query HostnameListParams

</summary>

ZoneID param.Field\[string]

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames%20%3E%20(method)%20list%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type Hostname struct{…}

</summary>

ID stringOptional

Specify the identifier of the hostname.

maxLength32

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

CreatedOn TimeOptional

formatdate-time

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

Description stringOptional

Specify an optional description of the hostname.

maxLength500

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20description">Link to this property</a>

Dnslink stringOptional

Specify the DNSLink value used if the target is ipfs.

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20dnslink">Link to this property</a>

ModifiedOn TimeOptional

formatdate-time

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

Name stringOptional

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

maxLength255

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

<details>

<summary>

Status HostnameStatusOptional

Specifies the status of the hostname’s activation.

</summary>

One of the following:

const HostnameStatusActive HostnameStatus = "active"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

const HostnameStatusPending HostnameStatus = "pending"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

const HostnameStatusDeleting HostnameStatus = "deleting"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%202">Link to this property</a>

const HostnameStatusError HostnameStatus = "error"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

<details>

<summary>

Target HostnameTargetOptional

Specify the target gateway of the hostname.

</summary>

One of the following:

const HostnameTargetEthereum HostnameTarget = "ethereum"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20target%20%3E%20(member)%200">Link to this property</a>

const HostnameTargetIPFS HostnameTarget = "ipfs"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20target%20%3E%20(member)%201">Link to this property</a>

const HostnameTargetIPFSUniversalPath HostnameTarget = "ipfs\_universal\_path"

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20target%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)%20%3E%20(property)%20target">Link to this property</a>

</details>

[Link to this property](<#(resource)%20web3.hostnames%20%3E%20(model)%20hostname%20%3E%20(schema)>)

### List Web3 Hostnames

Go

HTTPTypeScriptPythonGoTerraform

```
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"),
  )
  page, err := client.Web3.Hostnames.List(context.TODO(), web3.HostnameListParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

200 example

```
{
  "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": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
```

##### Returns Examples

200 example

```
{
  "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": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
```