Skip to content
Cloudflare API
Start here
API Reference
Tenant Custom Nameservers

Add Tenant Custom Nameserver

client.tenantCustomNameservers.create(stringtenantTag, TenantCustomNameserverCreateParams { ns_name, ns_set } body, RequestOptionsoptions?): TenantCustomNameserverCreateResponse { dns_records, ns_name, status, 2 more }
POST/tenants/{tenant_tag}/custom_ns

Add Tenant Custom Nameserver

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

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

Example:X-Auth-Email: user@example.com

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

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
ParametersExpand Collapse
tenantTag: string

Tenant identifier tag.

maxLength32
body: TenantCustomNameserverCreateParams { ns_name, ns_set }
ns_name: string

The FQDN of the name server.

formathostname
ns_set?: number

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

maximum5
minimum1
ReturnsExpand Collapse
TenantCustomNameserverCreateResponse { dns_records, ns_name, status, 2 more }

A single tenant custom nameserver.

dns_records: Array<DNSRecord>

A and AAAA records associated with the nameserver.

type?: "A" | "AAAA"

DNS record type.

One of the following:
"A"
"AAAA"
value?: string

DNS record contents (an IPv4 or IPv6 address).

ns_name: string

The FQDN of the name server.

formathostname
Deprecatedstatus: "moved" | "pending" | "verified"

Verification status of the nameserver.

One of the following:
"moved"
"pending"
"verified"
zone_tag: string

Identifier.

maxLength32
ns_set?: number

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

maximum5
minimum1

Add Tenant Custom Nameserver

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);
{
  "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
  }
}
Returns Examples
{
  "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
  }
}