# Hosts

## Retrieve schema hosts in a zone

`client.apiGateway.userSchemas.hosts.list(HostListParamsparams, RequestOptionsoptions?): V4PagePaginationArray<HostListResponse>`

**get** `/zones/{zone_id}/api_gateway/user_schemas/hosts`

Lists all unique hosts found in uploaded OpenAPI schemas for the zone. Useful for understanding which domains have schema coverage.

### Parameters

- `params: HostListParams`

  - `zone_id: string`

    Path param: Identifier.

  - `page?: number`

    Query param: Page number of paginated results.

  - `per_page?: number`

    Query param: Maximum number of results per page.

### Returns

- `HostListResponse`

  - `created_at: string`

  - `hosts: Array<string>`

    Hosts serving the schema, e.g zone.host.com

  - `name: string`

    Name of the schema

  - `schema_id: string`

    UUID.

### 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 hostListResponse of client.apiGateway.userSchemas.hosts.list({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(hostListResponse.schema_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"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "created_at": "2014-01-01T05:20:00.12345Z",
      "hosts": [
        "string"
      ],
      "name": "petstore schema",
      "schema_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Domain Types

### Host List Response

- `HostListResponse`

  - `created_at: string`

  - `hosts: Array<string>`

    Hosts serving the schema, e.g zone.host.com

  - `name: string`

    Name of the schema

  - `schema_id: string`

    UUID.