---
title: Add Account Custom Nameserver
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Account Custom Nameservers](https://developers.cloudflare.com/api/typescript/resources/custom%5Fnameservers)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Add Account Custom Nameserver

client.customNameservers.create(CustomNameserverCreateParams { account\_id, ns\_name, ns\_set } params, RequestOptionsoptions?): [CustomNameserver](https://developers.cloudflare.com/api/typescript/resources/custom%5Fnameservers#%28resource%29%20custom%5Fnameservers%20%3E%20%28model%29%20custom%5Fnameserver%20%3E%20%28schema%29) { dns\_records, ns\_name, status, 2 more } 

POST/accounts/{account\_id}/custom\_ns

Adds a custom nameserver to the account for use as a vanity nameserver on zones.

##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-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`

##### Accepted Permissions (at least one required)

`Account Settings Write`

##### ParametersExpand Collapse 

params: CustomNameserverCreateParams { account\_id, ns\_name, ns\_set } 

account\_id: string

Path param: Account identifier tag.

maxLength32

ns\_name: string

Body param: The FQDN of the name server.

formathostname

ns\_set?: number

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

maximum5

minimum1

##### ReturnsExpand Collapse 

CustomNameserver { dns\_records, ns\_name, status, 2 more } 

A single account 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 Account Custom Nameserver

TypeScript

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
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.customNameservers.create({
  account_id: '372e67954025e0ba6aaa6d586b9e0b59',
  ns_name: 'ns1.example.com',
});

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

200 example

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

200 example

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