# Custom Nameservers

## Get Account Custom Nameserver Related Zone Metadata

`client.zones.customNameservers.get(CustomNameserverGetParamsparams, RequestOptionsoptions?): CustomNameserverGetResponse`

**get** `/zones/{zone_id}/custom_ns`

Get metadata for account-level custom nameservers on a zone.

Deprecated in favor of [Show DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-list-dns-settings).

### Parameters

- `params: CustomNameserverGetParams`

  - `zone_id: string`

    Identifier.

### Returns

- `CustomNameserverGetResponse`

  - `errors: Array<Error>`

    - `code: number`

    - `message: string`

    - `documentation_url?: string`

    - `source?: Source`

      - `pointer?: string`

  - `messages: Array<Message>`

    - `code: number`

    - `message: string`

    - `documentation_url?: string`

    - `source?: Source`

      - `pointer?: string`

  - `success: true`

    Whether the API call was successful.

    - `true`

  - `enabled?: boolean`

    Whether zone uses account-level custom nameservers.

  - `ns_set?: number`

    The number of the name server set to assign to the zone.

  - `result_info?: ResultInfo`

    - `count?: number`

      Total number of results for the requested service.

    - `page?: number`

      Current page within paginated list of results.

    - `per_page?: number`

      Number of results per page of results.

    - `total_count?: number`

      Total results available without any search parameters.

### Example

```node
import Cloudflare from 'cloudflare';

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

const customNameserver = await client.zones.customNameservers.get({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(customNameserver.errors);
```

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

## Set Account Custom Nameserver Related Zone Metadata

`client.zones.customNameservers.update(CustomNameserverUpdateParamsparams, RequestOptionsoptions?): SinglePage<CustomNameserverUpdateResponse>`

**put** `/zones/{zone_id}/custom_ns`

Set metadata for account-level custom nameservers on a zone.

If you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.

Deprecated in favor of [Update DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-update-dns-settings).

### Parameters

- `params: CustomNameserverUpdateParams`

  - `zone_id: string`

    Path param: Identifier.

  - `enabled?: boolean`

    Body param: Whether zone uses account-level custom nameservers.

  - `ns_set?: number`

    Body param: The number of the name server set to assign to the zone.

### Returns

- `CustomNameserverUpdateResponse = string`

  Unused

### 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 customNameserverUpdateResponse of client.zones.customNameservers.update({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(customNameserverUpdateResponse);
}
```

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

## Domain Types

### Custom Nameserver Get Response

- `CustomNameserverGetResponse`

  - `errors: Array<Error>`

    - `code: number`

    - `message: string`

    - `documentation_url?: string`

    - `source?: Source`

      - `pointer?: string`

  - `messages: Array<Message>`

    - `code: number`

    - `message: string`

    - `documentation_url?: string`

    - `source?: Source`

      - `pointer?: string`

  - `success: true`

    Whether the API call was successful.

    - `true`

  - `enabled?: boolean`

    Whether zone uses account-level custom nameservers.

  - `ns_set?: number`

    The number of the name server set to assign to the zone.

  - `result_info?: ResultInfo`

    - `count?: number`

      Total number of results for the requested service.

    - `page?: number`

      Current page within paginated list of results.

    - `per_page?: number`

      Number of results per page of results.

    - `total_count?: number`

      Total results available without any search parameters.

### Custom Nameserver Update Response

- `CustomNameserverUpdateResponse = string`

  Unused