# Tenant Custom Nameservers

## List Tenant Custom Nameservers

`client.tenantCustomNameservers.get(stringtenantTag, RequestOptionsoptions?): SinglePage<TenantCustomNameserverGetResponse>`

**get** `/tenants/{tenant_tag}/custom_ns`

List a tenant's custom nameservers.

### Parameters

- `tenantTag: string`

  Tenant identifier tag.

### Returns

- `TenantCustomNameserverGetResponse`

  A single tenant custom nameserver.

  - `dns_records: Array<DNSRecord>`

    A and AAAA records associated with the nameserver.

    - `type?: "A" | "AAAA"`

      DNS record type.

      - `"A"`

      - `"AAAA"`

    - `value?: string`

      DNS record contents (an IPv4 or IPv6 address).

  - `ns_name: string`

    The FQDN of the name server.

  - `status: "moved" | "pending" | "verified"`

    Verification status of the nameserver.

    - `"moved"`

    - `"pending"`

    - `"verified"`

  - `zone_tag: string`

    Identifier.

  - `ns_set?: number`

    The number of the set that this name server belongs to.

### 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 tenantCustomNameserverGetResponse of client.tenantCustomNameservers.get(
  '699d98642c564d2e855e9661899b7252',
)) {
  console.log(tenantCustomNameserverGetResponse.dns_records);
}
```

#### 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": [
    {
      "dns_records": [
        {
          "type": "A",
          "value": "1.1.1.1"
        }
      ],
      "ns_name": "ns1.example.com",
      "status": "verified",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353",
      "ns_set": 1
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Add Tenant Custom Nameserver

`client.tenantCustomNameservers.create(stringtenantTag, TenantCustomNameserverCreateParamsbody, RequestOptionsoptions?): TenantCustomNameserverCreateResponse`

**post** `/tenants/{tenant_tag}/custom_ns`

Add Tenant Custom Nameserver

### Parameters

- `tenantTag: string`

  Tenant identifier tag.

- `body: TenantCustomNameserverCreateParams`

  - `ns_name: string`

    The FQDN of the name server.

  - `ns_set?: number`

    The number of the set that this name server belongs to.

### Returns

- `TenantCustomNameserverCreateResponse`

  A single tenant custom nameserver.

  - `dns_records: Array<DNSRecord>`

    A and AAAA records associated with the nameserver.

    - `type?: "A" | "AAAA"`

      DNS record type.

      - `"A"`

      - `"AAAA"`

    - `value?: string`

      DNS record contents (an IPv4 or IPv6 address).

  - `ns_name: string`

    The FQDN of the name server.

  - `status: "moved" | "pending" | "verified"`

    Verification status of the nameserver.

    - `"moved"`

    - `"pending"`

    - `"verified"`

  - `zone_tag: string`

    Identifier.

  - `ns_set?: number`

    The number of the set that this name server belongs to.

### 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 tenantCustomNameserver = await client.tenantCustomNameservers.create(
  '699d98642c564d2e855e9661899b7252',
  { ns_name: 'ns1.example.com' },
);

console.log(tenantCustomNameserver.dns_records);
```

#### 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": {
    "dns_records": [
      {
        "type": "A",
        "value": "1.1.1.1"
      }
    ],
    "ns_name": "ns1.example.com",
    "status": "verified",
    "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353",
    "ns_set": 1
  }
}
```

## Delete Tenant Custom Nameserver

`client.tenantCustomNameservers.delete(stringtenantTag, stringcustomNSId, RequestOptionsoptions?): SinglePage<TenantCustomNameserverDeleteResponse>`

**delete** `/tenants/{tenant_tag}/custom_ns/{custom_ns_id}`

Delete Tenant Custom Nameserver

### Parameters

- `tenantTag: string`

  Tenant identifier tag.

- `customNSId: string`

  The FQDN of the name server.

### Returns

- `TenantCustomNameserverDeleteResponse = 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 tenantCustomNameserverDeleteResponse of client.tenantCustomNameservers.delete(
  '699d98642c564d2e855e9661899b7252',
  'ns1.example.com',
)) {
  console.log(tenantCustomNameserverDeleteResponse);
}
```

#### 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,
    "total_pages": 100
  }
}
```

## Domain Types

### Tenant Custom Nameserver Get Response

- `TenantCustomNameserverGetResponse`

  A single tenant custom nameserver.

  - `dns_records: Array<DNSRecord>`

    A and AAAA records associated with the nameserver.

    - `type?: "A" | "AAAA"`

      DNS record type.

      - `"A"`

      - `"AAAA"`

    - `value?: string`

      DNS record contents (an IPv4 or IPv6 address).

  - `ns_name: string`

    The FQDN of the name server.

  - `status: "moved" | "pending" | "verified"`

    Verification status of the nameserver.

    - `"moved"`

    - `"pending"`

    - `"verified"`

  - `zone_tag: string`

    Identifier.

  - `ns_set?: number`

    The number of the set that this name server belongs to.

### Tenant Custom Nameserver Create Response

- `TenantCustomNameserverCreateResponse`

  A single tenant custom nameserver.

  - `dns_records: Array<DNSRecord>`

    A and AAAA records associated with the nameserver.

    - `type?: "A" | "AAAA"`

      DNS record type.

      - `"A"`

      - `"AAAA"`

    - `value?: string`

      DNS record contents (an IPv4 or IPv6 address).

  - `ns_name: string`

    The FQDN of the name server.

  - `status: "moved" | "pending" | "verified"`

    Verification status of the nameserver.

    - `"moved"`

    - `"pending"`

    - `"verified"`

  - `zone_tag: string`

    Identifier.

  - `ns_set?: number`

    The number of the set that this name server belongs to.

### Tenant Custom Nameserver Delete Response

- `TenantCustomNameserverDeleteResponse = string`

  Unused