---
title: Add Tenant Custom Nameserver
---

[Skip to content](#_top)

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

[Tenant Custom Nameservers](https://developers.cloudflare.com/api/python/resources/tenant_custom_nameservers)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Add Tenant Custom Nameserver

tenant\_custom\_nameservers.create(strtenant\_tag, TenantCustomNameserverCreateParams\*\*kwargs) -> [TenantCustomNameserverCreateResponse](<https://developers.cloudflare.com/api/python/resources/tenant_custom_nameservers#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)>)

POST/tenants/{tenant\_tag}/custom\_ns

Adds a custom nameserver for a tenant.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



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

**Example:**<code>X-Auth-Email: user@example.com</code>

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

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### ParametersExpand Collapse

tenant\_tag: str

Tenant identifier tag.

maxLength32

[Link to this property](<#(resource)%20tenant_custom_nameservers%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20tenant_tag%20%3E%20(schema)>)

ns\_name: str

The FQDN of the name server.

formathostname

[Link to this property](<#(resource)%20tenant_custom_nameservers%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20ns_name%20%3E%20(schema)>)

ns\_set: Optional\[float]

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

maximum5

minimum1

[Link to this property](<#(resource)%20tenant_custom_nameservers%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20ns_set%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class TenantCustomNameserverCreateResponse: …

A single tenant custom nameserver.

</summary>

<details>

<summary>

dns\_records: List\[DNSRecord]

A and AAAA records associated with the nameserver.

</summary>

<details>

<summary>

type: Optional\[Literal\["A", "AAAA"]]

DNS record type.

</summary>

One of the following:

"A"

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20dns_records%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"AAAA"

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20dns_records%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20dns_records%20%3E%20(items)%20%3E%20(property)%20type">Link to this property</a>

value: Optional\[str]

DNS record contents (an IPv4 or IPv6 address).

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20dns_records%20%3E%20(items)%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20dns_records">Link to this property</a>

ns\_name: str

The FQDN of the name server.

formathostname

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20ns_name">Link to this property</a>

<details>

<summary>

Deprecatedstatus: Literal\["moved", "pending", "verified"]

Verification status of the nameserver.

</summary>

One of the following:

"moved"

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

"pending"

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

"verified"

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

zone\_tag: str

Identifier.

maxLength32

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20zone_tag">Link to this property</a>

ns\_set: Optional\[float]

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

maximum5

minimum1

<a href="#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)%20%3E%20(property)%20ns_set">Link to this property</a>

</details>

[Link to this property](<#(resource)%20tenant_custom_nameservers%20%3E%20(model)%20tenant_custom_nameserver_create_response%20%3E%20(schema)>)

### Add Tenant Custom Nameserver

Python

HTTPTypeScriptPythonGoTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
tenant_custom_nameserver = client.tenant_custom_nameservers.create(
    tenant_tag="699d98642c564d2e855e9661899b7252",
    ns_name="ns1.example.com",
)
print(tenant_custom_nameserver.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
  }
}
```