Skip to content
Start here

Zone

Show DNS Settings
GET/zones/{zone_id}/dns_settings
Update DNS Settings
PATCH/zones/{zone_id}/dns_settings
ModelsExpand Collapse
ZoneGetResponse { flatten_all_cnames, foundation_dns, internal_dns, 6 more }
flatten_all_cnames: boolean

Whether to flatten all CNAME records in the zone. Note that, due to DNS limitations, a CNAME record at the zone apex will always be flattened.

foundation_dns: boolean

Whether to enable Foundation DNS Advanced Nameservers on the zone.

internal_dns: { reference_zone_id }

Settings for this internal zone.

reference_zone_id: optional string

The ID of the zone to fallback to.

multi_provider: boolean

Whether to enable multi-provider DNS, which causes Cloudflare to activate the zone even when non-Cloudflare NS records exist, and to respect NS records at the zone apex during outbound zone transfers.

nameservers: { type, ns_set }

Settings determining the nameservers through which the zone should be available.

type: "cloudflare.standard" or "custom.account" or "custom.tenant" or "custom.zone"

Nameserver type

One of the following:
"cloudflare.standard"
"custom.account"
"custom.tenant"
"custom.zone"
ns_set: optional number

Configured nameserver set to be used for this zone

maximum5
minimum1
ns_ttl: number

The time to live (TTL) of the zone’s nameserver (NS) records.

maximum86400
minimum30
secondary_overrides: boolean

Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.

soa: { expire, min_ttl, mname, 4 more }

Components of the zone’s SOA record.

expire: optional number

Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.

maximum2419200
minimum86400
min_ttl: optional number

The time to live (TTL) for negative caching of records within the zone.

maximum86400
minimum60
mname: optional string

The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.

refresh: optional number

Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.

maximum86400
minimum600
retry: optional number

Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.

maximum86400
minimum600
rname: optional string

The email address of the zone administrator, with the first label representing the local part of the email address.

ttl: optional number

The time to live (TTL) of the SOA record itself.

maximum86400
minimum300
zone_mode: "standard" or "cdn_only" or "dns_only"

Whether the zone mode is a regular or CDN/DNS only zone.

One of the following:
"standard"
"cdn_only"
"dns_only"
ZoneEditResponse { flatten_all_cnames, foundation_dns, internal_dns, 6 more }
flatten_all_cnames: boolean

Whether to flatten all CNAME records in the zone. Note that, due to DNS limitations, a CNAME record at the zone apex will always be flattened.

foundation_dns: boolean

Whether to enable Foundation DNS Advanced Nameservers on the zone.

internal_dns: { reference_zone_id }

Settings for this internal zone.

reference_zone_id: optional string

The ID of the zone to fallback to.

multi_provider: boolean

Whether to enable multi-provider DNS, which causes Cloudflare to activate the zone even when non-Cloudflare NS records exist, and to respect NS records at the zone apex during outbound zone transfers.

nameservers: { type, ns_set }

Settings determining the nameservers through which the zone should be available.

type: "cloudflare.standard" or "custom.account" or "custom.tenant" or "custom.zone"

Nameserver type

One of the following:
"cloudflare.standard"
"custom.account"
"custom.tenant"
"custom.zone"
ns_set: optional number

Configured nameserver set to be used for this zone

maximum5
minimum1
ns_ttl: number

The time to live (TTL) of the zone’s nameserver (NS) records.

maximum86400
minimum30
secondary_overrides: boolean

Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.

soa: { expire, min_ttl, mname, 4 more }

Components of the zone’s SOA record.

expire: optional number

Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.

maximum2419200
minimum86400
min_ttl: optional number

The time to live (TTL) for negative caching of records within the zone.

maximum86400
minimum60
mname: optional string

The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.

refresh: optional number

Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.

maximum86400
minimum600
retry: optional number

Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.

maximum86400
minimum600
rname: optional string

The email address of the zone administrator, with the first label representing the local part of the email address.

ttl: optional number

The time to live (TTL) of the SOA record itself.

maximum86400
minimum300
zone_mode: "standard" or "cdn_only" or "dns_only"

Whether the zone mode is a regular or CDN/DNS only zone.

One of the following:
"standard"
"cdn_only"
"dns_only"