Settings
SettingsZone
Show DNS Settings
Update DNS Settings
ModelsExpand Collapse
ZoneGetResponse object { flatten_all_cnames, foundation_dns, internal_dns, 6 more }
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 is deprecated. Use nameservers.type: cloudflare.advanced to turn on Advanced Nameservers and cloudflare.standard to turn it off. This field will be removed in a future API version.
Deprecated. Use nameservers.type to configure Advanced Nameservers.
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: object { type } or object { type, ns_set } or object { nameserver_set_id, type } Controls the nameservers through which the zone is available.
Controls the nameservers through which the zone is available.
Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.
soa: object { expire, min_ttl, mname, 4 more } Components of the zone’s SOA record.
Components of the zone’s SOA record.
Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
The time to live (TTL) for negative caching of records within the zone.
The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
ZoneEditResponse object { flatten_all_cnames, foundation_dns, internal_dns, 6 more }
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 is deprecated. Use nameservers.type: cloudflare.advanced to turn on Advanced Nameservers and cloudflare.standard to turn it off. This field will be removed in a future API version.
Deprecated. Use nameservers.type to configure Advanced Nameservers.
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: object { type } or object { type, ns_set } or object { nameserver_set_id, type } Controls the nameservers through which the zone is available.
Controls the nameservers through which the zone is available.
Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.
soa: object { expire, min_ttl, mname, 4 more } Components of the zone’s SOA record.
Components of the zone’s SOA record.
Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
The time to live (TTL) for negative caching of records within the zone.
The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
SettingsAccount
Show DNS Settings
Update DNS Settings
ModelsExpand Collapse
AccountGetResponse object { zone_defaults, enforce_dns_only }
zone_defaults: object { flatten_all_cnames, foundation_dns, internal_dns, 6 more } Default settings for new zones created in this account.
Default settings for new zones created in this account.
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 is deprecated. Use nameservers.type: cloudflare.advanced to turn on Advanced Nameservers and cloudflare.standard to turn it off. This field will be removed in a future API version.
Deprecated. Use nameservers.type to configure Advanced Nameservers.
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: object { type } Settings determining the nameservers through which the zone should be available.
Settings determining the nameservers through which the zone should be available.
Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.
soa: object { expire, min_ttl, mname, 4 more } Components of the zone’s SOA record.
Components of the zone’s SOA record.
Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
The time to live (TTL) for negative caching of records within the zone.
The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
When enabled, forces all proxied DNS records in the account to behave as DNS-only at the edge, regardless of each record’s individual proxy setting. Note that this account-level override does not modify the records themselves; it only affects how they are served at the edge. See more on Enforce DNS-only.
AccountEditResponse object { zone_defaults, enforce_dns_only }
zone_defaults: object { flatten_all_cnames, foundation_dns, internal_dns, 6 more } Default settings for new zones created in this account.
Default settings for new zones created in this account.
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 is deprecated. Use nameservers.type: cloudflare.advanced to turn on Advanced Nameservers and cloudflare.standard to turn it off. This field will be removed in a future API version.
Deprecated. Use nameservers.type to configure Advanced Nameservers.
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: object { type } Settings determining the nameservers through which the zone should be available.
Settings determining the nameservers through which the zone should be available.
Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.
soa: object { expire, min_ttl, mname, 4 more } Components of the zone’s SOA record.
Components of the zone’s SOA record.
Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
The time to live (TTL) for negative caching of records within the zone.
The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
When enabled, forces all proxied DNS records in the account to behave as DNS-only at the edge, regardless of each record’s individual proxy setting. Note that this account-level override does not modify the records themselves; it only affects how they are served at the edge. See more on Enforce DNS-only.
SettingsAccountNameserver Sets
List Custom Nameserver Sets
Get Custom Nameserver Set
Create Custom Nameserver Set
Delete Custom Nameserver Set
ModelsExpand Collapse
NameserverSetListResponse = object { id, advanced, created_on, 2 more } or object { id, advanced, created_on, 2 more }
DNSSettingsNameserverSetStandardResponse object { id, advanced, created_on, 2 more }
DNSSettingsNameserverSetAdvancedResponse object { id, advanced, created_on, 2 more }
Selects the account-specific IP set that supplies the nameserver addresses. The account’s entitlement determines the maximum value. Nameserver sets with the same ip_set and advanced value may reuse addresses; otherwise, they use disjoint address groups.
nameservers: array of object { ipv4, ipv4_groups, ipv6, 2 more }
ipv4_groups: array of "a" or "b" or "c"Advanced anycast group for each address in the corresponding address array. Entries have the same order as, and correspond one-to-one with, the addresses.
Advanced anycast group for each address in the corresponding address array. Entries have the same order as, and correspond one-to-one with, the addresses.
NameserverSetGetResponse = object { id, advanced, created_on, 2 more } or object { id, advanced, created_on, 2 more }
DNSSettingsNameserverSetStandardResponse object { id, advanced, created_on, 2 more }
DNSSettingsNameserverSetAdvancedResponse object { id, advanced, created_on, 2 more }
Selects the account-specific IP set that supplies the nameserver addresses. The account’s entitlement determines the maximum value. Nameserver sets with the same ip_set and advanced value may reuse addresses; otherwise, they use disjoint address groups.
nameservers: array of object { ipv4, ipv4_groups, ipv6, 2 more }
ipv4_groups: array of "a" or "b" or "c"Advanced anycast group for each address in the corresponding address array. Entries have the same order as, and correspond one-to-one with, the addresses.
Advanced anycast group for each address in the corresponding address array. Entries have the same order as, and correspond one-to-one with, the addresses.
NameserverSetCreateResponse = object { id, advanced, created_on, 2 more } or object { id, advanced, created_on, 2 more }
DNSSettingsNameserverSetStandardResponse object { id, advanced, created_on, 2 more }
DNSSettingsNameserverSetAdvancedResponse object { id, advanced, created_on, 2 more }
Selects the account-specific IP set that supplies the nameserver addresses. The account’s entitlement determines the maximum value. Nameserver sets with the same ip_set and advanced value may reuse addresses; otherwise, they use disjoint address groups.
nameservers: array of object { ipv4, ipv4_groups, ipv6, 2 more }
ipv4_groups: array of "a" or "b" or "c"Advanced anycast group for each address in the corresponding address array. Entries have the same order as, and correspond one-to-one with, the addresses.
Advanced anycast group for each address in the corresponding address array. Entries have the same order as, and correspond one-to-one with, the addresses.