## List Web3 Hostnames

`client.web3.hostnames.list(HostnameListParamsparams, RequestOptionsoptions?): SinglePage<Hostname>`

**get** `/zones/{zone_id}/web3/hostnames`

List Web3 Hostnames

### Parameters

- `params: HostnameListParams`

  - `zone_id: string`

    Specify the identifier of the hostname.

### Returns

- `Hostname`

  - `id?: string`

    Specify the identifier of the hostname.

  - `created_on?: string`

  - `description?: string`

    Specify an optional description of the hostname.

  - `dnslink?: string`

    Specify the DNSLink value used if the target is ipfs.

  - `modified_on?: string`

  - `name?: string`

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

  - `status?: "active" | "pending" | "deleting" | "error"`

    Specifies the status of the hostname's activation.

    - `"active"`

    - `"pending"`

    - `"deleting"`

    - `"error"`

  - `target?: "ethereum" | "ipfs" | "ipfs_universal_path"`

    Specify the target gateway of the hostname.

    - `"ethereum"`

    - `"ipfs"`

    - `"ipfs_universal_path"`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const hostname of client.web3.hostnames.list({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(hostname.id);
}
```

#### Response

```json
{
  "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
  }
}
```