Cloudflare API | Account Custom Nameservers › Add Account Custom Nameserver

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

List Account Custom Nameservers

Add Account Custom Nameserver

Delete Account Custom Nameserver

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Account Custom Nameservers

custom_nameservers

Methods

List Account Custom Nameservers -> SinglePage<

CustomNameserver

>

get/accounts/{account_id}/custom_ns

List an account's custom nameservers.

Add Account Custom Nameserver -> Envelope<

CustomNameserver

>

post/accounts/{account_id}/custom_ns

Add Account Custom Nameserver

Security

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

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Account Settings Write

path Parameters

account_id: string

(maxLength: 32)

Account identifier tag.

Response fields

errors: Array<{ code, message, documentation_url, 1 more... }>

messages: Array<{ code, message, documentation_url, 1 more... }>

success: true

Whether the API call was successful.

result:

CustomNameserver

Optional

A single account custom nameserver.

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/custom_ns \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
          "ns_name": "ns1.example.com",
          "ns_set": 1
        }'

200Example

{
  "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 Account Custom Nameserver -> SinglePage<string>

delete/accounts/{account_id}/custom_ns/{custom_ns_id}

Delete Account Custom Nameserver

Domain types

CustomNameserver = { dns_records, ns_name, status, 2 more... }

A single account custom nameserver.