Cloudflare API | Zones › Custom Nameservers › Set Account Custom Nameserver Related Zone Metadata

If you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.

Deprecated in favor of Update DNS Settings.

Security

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

Parameters

zone_id: string

Identifier

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result: Array<string>

Optional

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/custom_ns \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "enabled": true,
      "ns_set": 1
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": [],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Zones

Holds

zones.holds

Methods

Create Zone Hold -> Envelope<

ZoneHold

post/zones/{zone_id}/hold

Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname.

Remove Zone Hold -> Envelope<

ZoneHold

delete/zones/{zone_id}/hold

Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the creation and activation of zones with this zone's hostname.

Update Zone Hold -> Envelope<

ZoneHold

patch/zones/{zone_id}/hold

Update the hold_after and/or include_subdomains values on an existing zone hold. The hold is enabled if the hold_after date-time value is in the past.

Get Zone Hold -> Envelope<

ZoneHold

get/zones/{zone_id}/hold

Retrieve whether the zone is subject to a zone hold, and metadata about the hold.

Domain types

ZoneHold = { hold, hold_after, include_subdomains }

Zones

Plans

zones.plans

Methods

Available Plan Details -> Envelope<

AvailableRatePlan

get/zones/{zone_id}/available_plans/{plan_identifier}

Details of the available plan that the zone can subscribe to.

List Available Plans -> SinglePage<

AvailableRatePlan

get/zones/{zone_id}/available_plans

Lists available plans the zone can subscribe to.

Domain types

AvailableRatePlan = { id, can_subscribe, currency, 7 more... }

Zones

Rate Plans

zones.rate_plans

Methods

List Available Rate Plans -> Envelope<Array<{ id, components, currency, 3 more... }>>

get/zones/{zone_id}/available_rate_plans

Lists all rate plans the zone can subscribe to.

Zones

Settings

zones.settings

Methods

Edit Zone Setting -> Envelope<

ZeroRTT

AdvancedDDoS

AlwaysOnline

| 50 more...>

patch/zones/{zone_id}/settings/{setting_id}

Updates a single zone setting by the identifier

Get Zone Setting -> Envelope<

ZeroRTT

AdvancedDDoS

AlwaysOnline

| 50 more...>

get/zones/{zone_id}/settings/{setting_id}

Fetch a single zone setting by name

Domain types

AdvancedDDoS = { id, value, editable, 1 more... }

AlwaysOnline = { id, value, editable, 1 more... }

AlwaysUseHTTPS = { id }

AutomaticHTTPSRewrites = { id, value }

AutomaticPlatformOptimization = { cache_by_device_type, cf, enabled, 3 more... }

Brotli = { id, value, editable, 1 more... }

BrowserCacheTTL = { id, value }

BrowserCheck = { id, value }

CacheLevel = { id, value }

ChallengeTTL = { id, value, editable, 1 more... }

Ciphers = { id, value, editable, 1 more... }

DevelopmentMode = { id, value, editable, 2 more... }

EarlyHints = { id, value, editable, 1 more... }

EmailObfuscation = { id, value }

FontSettings = { id, editable, modified_on, 1 more... }

H2Prioritization = { id, value, editable, 1 more... }

HotlinkProtection = { id, value, editable, 1 more... }

HTTP2 = { id, value, editable, 1 more... }

HTTP3 = { id, value, editable, 1 more... }

ImageResizing = { id, value, editable, 1 more... }

IPGeolocation = { id, value }

IPV6 = { id, value, editable, 1 more... }

MinTLSVersion = { id, value, editable, 1 more... }

Mirage = { id, value }

NEL = { id, value, editable, 1 more... }

OpportunisticEncryption = { id, value }

OpportunisticOnion = { id, value, editable, 1 more... }

OrangeToOrange = { id, value, editable, 1 more... }

OriginErrorPagePassThru = { id, value }

OriginMaxHTTPVersion = "origin_max_http_version"

Polish = { id, value }

PrefetchPreload = { id, value, editable, 1 more... }

ProxyReadTimeout = { id, value, editable, 1 more... }

PseudoIPV4 = { id, value, editable, 1 more... }

ResponseBuffering = { id, value }

RocketLoader = { id, value }

SecurityHeaders = { id, value, editable, 1 more... }

SecurityLevel = { id, value }

ServerSideExcludes = { id, value, editable, 1 more... }

SortQueryStringForCache = { id, value }

SSL = { id, value }

SSLRecommender = { id, enabled }

TLS1_3 = { id, value, editable, 1 more... }

TLSClientAuth = { id, value, editable, 1 more... }

TrueClientIPHeader = { id, value }

WAF = { id, value }

WebP = { id, value, editable, 1 more... }

Websocket = { id, value, editable, 1 more... }

ZeroRTT = { id, value, editable, 1 more... }

Zones

Subscriptions

zones.subscriptions

Methods

Create Zone Subscription -> Envelope<unknown>

post/zones/{identifier}/subscription

Create a zone subscription, either plan or add-ons.

Zone Subscription Details -> Envelope<unknown>

get/zones/{identifier}/subscription

Lists zone subscription details.

Update Zone Subscription -> Envelope<unknown>

put/zones/{identifier}/subscription

Updates zone subscriptions, either plan or add-ons.