[ Web Proxy ]
URL:
Viewing: https://developers.cloudflare.com/api/resources/tenant_custom_nameservers/methods/create [Back]  [Original]
Add Tenant Custom Nameserver | Cloudflare API Skip to content
logo.DMYpXs3t.svg [logo.DMYpXs3t.svg] Cloudflare API
CtrlK
Start here
Start here
HTTP
API Reference
Tenant Custom Nameservers
Copy Markdown

Add Tenant Custom Nameserver

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
Path ParametersExpand Collapse
tenant_tag: string

Tenant identifier tag.

maxLength32
Body ParametersJSONExpand Collapse
ns_name: string

The FQDN of the name server.

formathostname
ns_set: optional number

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

maximum5
minimum1
ReturnsExpand Collapse
errors: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Whether the API call was successful.

result: optional object { dns_records, ns_name, status, 2 more }

A single tenant custom nameserver.

dns_records: array of object { type, value }

A and AAAA records associated with the nameserver.

type: optional "A" or "AAAA"

DNS record type.

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

DNS record contents (an IPv4 or IPv6 address).

ns_name: string

The FQDN of the name server.

formathostname
Deprecatedstatus: "moved" or "pending" or "verified"

Verification status of the nameserver.

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

Identifier.

maxLength32
ns_set: optional number

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

maximum5
minimum1

Add Tenant Custom Nameserver

HTTP
curl https://api.cloudflare.com/client/v4/tenants/$TENANT_TAG/custom_ns \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "ns_name": "ns1.example.com",
          "ns_set": 1
        }'
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
  }
}
Web Proxy Viewer  |  New URL  |  Original Page