--- title: Settings --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [DNS](https://developers.cloudflare.com/api/typescript/resources/dns) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Settings #### SettingsZone ##### [Show DNS Settings](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/zone/methods/get) client.dns.settings.zone.get(ZoneGetParams {zone\_id } params, RequestOptionsoptions?): [ZoneGetResponse]() {flatten\_all\_cnames, foundation\_dns, internal\_dns, 6 more } GET/zones/{zone\_id}/dns\_settings ##### [Update DNS Settings](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/zone/methods/edit) client.dns.settings.zone.edit(ZoneEditParams {zone\_id, flatten\_all\_cnames, foundation\_dns, 7 more } params, RequestOptionsoptions?): [ZoneEditResponse]() {flatten\_all\_cnames, foundation\_dns, internal\_dns, 6 more } 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. Link to this property Deprecatedfoundation\_dns: boolean 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. Link to this property

internal\_dns: InternalDNS {reference\_zone\_id } Settings for this internal zone.

reference\_zone\_id?: string The ID of the zone to fallback to. Link to this property

Link to this property 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. Link to this property

nameservers: DNSSettingsZoneNameserversCloudflare {type } | DNSSettingsZoneNameserversCustomExisting {type, ns\_set } | DNSSettingsZoneNameserversCustomSet {nameserver\_set\_id, type } Controls the nameservers through which the zone is available.

One of the following:

DNSSettingsZoneNameserversCloudflare {type }

type: "cloudflare.standard"| "cloudflare.advanced" Nameserver type.

One of the following: "cloudflare.standard" Link to this property "cloudflare.advanced" Link to this property

Link to this property

DNSSettingsZoneNameserversCustomExisting {type, ns\_set }

type: "custom.account"| "custom.tenant"| "custom.zone" Nameserver type.

One of the following: "custom.account" Link to this property "custom.tenant" Link to this property "custom.zone" Link to this property

Link to this property ns\_set?: number Configured nameserver set number to use for this zone. maximum5 minimum1 Link to this property

Link to this property

DNSSettingsZoneNameserversCustomSet {nameserver\_set\_id, type }

nameserver\_set\_id: string Identifier of the account-owned Custom Nameserver Set to use for this zone. maxLength32 minLength32 Link to this property type: "custom" Nameserver type. Link to this property

Link to this property

Link to this property ns\_ttl: number The time to live (TTL) of the zone’s nameserver (NS) records. maximum86400 minimum30 Link to this property secondary\_overrides: boolean Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex. Link to this property

soa: SOA {expire, min\_ttl, mname, 4 more } Components of the zone’s SOA record.

expire?: number Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone. maximum2419200 minimum86400 Link to this property min\_ttl?: number The time to live (TTL) for negative caching of records within the zone. maximum86400 minimum60 Link to this property mname?: string| null The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used. Link to this property refresh?: number Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated. maximum86400 minimum600 Link to this property retry?: number Time in seconds after which secondary servers should retry queries after the primary server was unresponsive. maximum86400 minimum600 Link to this property rname?: string The email address of the zone administrator, with the first label representing the local part of the email address. Link to this property ttl?: number The time to live (TTL) of the SOA record itself. maximum86400 minimum300 Link to this property

Link to this property

zone\_mode: "standard"| "cdn\_only"| "dns\_only" Whether the zone mode is a regular or CDN/DNS only zone.

One of the following: "standard" Link to this property "cdn\_only" Link to this property "dns\_only" Link to this property

Link to this property

[Link to this property](<#(resource)%20dns.settings.zone%20%3E%20(model)%20zone_get_response%20%3E%20(schema)>)

ZoneEditResponse {flatten\_all\_cnames, foundation\_dns, internal\_dns, 6 more }

internal\_dns: InternalDNS {reference\_zone\_id } Settings for this internal zone.

reference\_zone\_id?: string The ID of the zone to fallback to. Link to this property

One of the following:

DNSSettingsZoneNameserversCloudflare {type }

type: "cloudflare.standard"| "cloudflare.advanced" Nameserver type.

One of the following: "cloudflare.standard" Link to this property "cloudflare.advanced" Link to this property

Link to this property

DNSSettingsZoneNameserversCustomExisting {type, ns\_set }

type: "custom.account"| "custom.tenant"| "custom.zone" Nameserver type.

One of the following: "custom.account" Link to this property "custom.tenant" Link to this property "custom.zone" Link to this property

Link to this property ns\_set?: number Configured nameserver set number to use for this zone. maximum5 minimum1 Link to this property

Link to this property

DNSSettingsZoneNameserversCustomSet {nameserver\_set\_id, type }

Link to this property

soa: SOA {expire, min\_ttl, mname, 4 more } Components of the zone’s SOA record.

Link to this property

zone\_mode: "standard"| "cdn\_only"| "dns\_only" Whether the zone mode is a regular or CDN/DNS only zone.

One of the following: "standard" Link to this property "cdn\_only" Link to this property "dns\_only" Link to this property

Link to this property

[Link to this property](<#(resource)%20dns.settings.zone%20%3E%20(model)%20zone_edit_response%20%3E%20(schema)>) #### SettingsAccount ##### [Show DNS Settings](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/methods/get) client.dns.settings.account.get(AccountGetParams {account\_id } params, RequestOptionsoptions?): [AccountGetResponse]() {zone\_defaults, enforce\_dns\_only } GET/accounts/{account\_id}/dns\_settings ##### [Update DNS Settings](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/methods/edit) client.dns.settings.account.edit(AccountEditParams {account\_id, enforce\_dns\_only, zone\_defaults } params, RequestOptionsoptions?): [AccountEditResponse]() {zone\_defaults, enforce\_dns\_only } PATCH/accounts/{account\_id}/dns\_settings ##### ModelsExpand Collapse

AccountGetResponse {zone\_defaults, enforce\_dns\_only }

zone\_defaults: ZoneDefaults {flatten\_all\_cnames, foundation\_dns, internal\_dns, 6 more } Default settings for new zones created in this account.

internal\_dns: InternalDNS {reference\_zone\_id } Settings for this internal zone.

reference\_zone\_id?: string The ID of the zone to fallback to. Link to this property

nameservers: Nameservers {type } Settings determining the nameservers through which the zone should be available.

type: "cloudflare.standard"| "cloudflare.advanced"| "cloudflare.standard.random"| 2 more Nameserver type

One of the following: "cloudflare.standard" Link to this property "cloudflare.advanced" Link to this property "cloudflare.standard.random" Link to this property "custom.account" Link to this property "custom.tenant" Link to this property

Link to this property

soa: SOA {expire, min\_ttl, mname, 4 more } Components of the zone’s SOA record.

Link to this property

zone\_mode: "standard"| "cdn\_only"| "dns\_only" Whether the zone mode is a regular or CDN/DNS only zone.

One of the following: "standard" Link to this property "cdn\_only" Link to this property "dns\_only" Link to this property

Link to this property

Link to this property enforce\_dns\_only?: boolean 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. Link to this property

[Link to this property](<#(resource)%20dns.settings.account%20%3E%20(model)%20account_get_response%20%3E%20(schema)>)

AccountEditResponse {zone\_defaults, enforce\_dns\_only }

zone\_defaults: ZoneDefaults {flatten\_all\_cnames, foundation\_dns, internal\_dns, 6 more } Default settings for new zones created in this account.

internal\_dns: InternalDNS {reference\_zone\_id } Settings for this internal zone.

reference\_zone\_id?: string The ID of the zone to fallback to. Link to this property

nameservers: Nameservers {type } Settings determining the nameservers through which the zone should be available.

type: "cloudflare.standard"| "cloudflare.advanced"| "cloudflare.standard.random"| 2 more Nameserver type

Link to this property

soa: SOA {expire, min\_ttl, mname, 4 more } Components of the zone’s SOA record.

Link to this property

zone\_mode: "standard"| "cdn\_only"| "dns\_only" Whether the zone mode is a regular or CDN/DNS only zone.

One of the following: "standard" Link to this property "cdn\_only" Link to this property "dns\_only" Link to this property

Link to this property

[Link to this property](<#(resource)%20dns.settings.account%20%3E%20(model)%20account_edit_response%20%3E%20(schema)>) #### SettingsAccountNameserver Sets ##### [List Custom Nameserver Sets](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/nameserver_sets/methods/list) client.dns.settings.account.nameserverSets.list(NameserverSetListParams {account\_id, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [NameserverSetListResponse]()> GET/accounts/{account\_id}/dns\_settings/nameserver\_sets ##### [Get Custom Nameserver Set](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/nameserver_sets/methods/get) client.dns.settings.account.nameserverSets.get(stringnameserverSetID, NameserverSetGetParams {account\_id } params, RequestOptionsoptions?): [NameserverSetGetResponse]() GET/accounts/{account\_id}/dns\_settings/nameserver\_sets/{nameserver\_set\_id} ##### [Create Custom Nameserver Set](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/nameserver_sets/methods/create) client.dns.settings.account.nameserverSets.create(NameserverSetCreateParams {account\_id, nameservers, advanced, ip\_set } params, RequestOptionsoptions?): [NameserverSetCreateResponse]() POST/accounts/{account\_id}/dns\_settings/nameserver\_sets ##### [Delete Custom Nameserver Set](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/nameserver_sets/methods/delete) client.dns.settings.account.nameserverSets.delete(stringnameserverSetID, NameserverSetDeleteParams {account\_id } params, RequestOptionsoptions?): [NameserverSetDeleteResponse]() {id } DELETE/accounts/{account\_id}/dns\_settings/nameserver\_sets/{nameserver\_set\_id} ##### ModelsExpand Collapse

NameserverSetListResponse = DNSSettingsNameserverSetStandardResponse {id, advanced, created\_on, 2 more } | DNSSettingsNameserverSetAdvancedResponse {id, advanced, created\_on, 2 more }

One of the following:

DNSSettingsNameserverSetStandardResponse {id, advanced, created\_on, 2 more }

id: string Identifier for a nameserver set. maxLength32 minLength32 Link to this property advanced: false Whether the nameserver set uses Advanced anycast groups. Link to this property created\_on: string When the nameserver set was created. formatdate-time Link to this property ip\_set: number 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. formatint64 minimum1 Link to this property

nameservers: Array<Nameserver>

ipv4: Array<string> IPv4 addresses assigned to the nameserver. Link to this property ipv6: Array<string> IPv6 addresses assigned to the nameserver. Link to this property name: string A unique lowercase Punycode nameserver name within the set. Link to this property

Link to this property

DNSSettingsNameserverSetAdvancedResponse {id, advanced, created\_on, 2 more }

id: string Identifier for a nameserver set. maxLength32 minLength32 Link to this property advanced: true Whether the nameserver set uses Advanced anycast groups. Link to this property created\_on: string When the nameserver set was created. formatdate-time Link to this property ip\_set: number 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. formatint64 minimum1 Link to this property

nameservers: Array<Nameserver>

ipv4: Array<string> IPv4 addresses assigned to the nameserver. Link to this property

ipv4\_groups: Array<"a"| "b"| "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.

One of the following: "a" Link to this property "b" Link to this property "c" Link to this property

Link to this property ipv6: Array<string> IPv6 addresses assigned to the nameserver. Link to this property

ipv6\_groups: Array<"a"| "b"| "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.

One of the following: "a" Link to this property "b" Link to this property "c" Link to this property

Link to this property name: string A unique lowercase Punycode nameserver name within the set. Link to this property

Link to this property

[Link to this property](<#(resource)%20dns.settings.account.nameserver_sets%20%3E%20(model)%20nameserver_set_list_response%20%3E%20(schema)>)

NameserverSetGetResponse = DNSSettingsNameserverSetStandardResponse {id, advanced, created\_on, 2 more } | DNSSettingsNameserverSetAdvancedResponse {id, advanced, created\_on, 2 more }

One of the following:

DNSSettingsNameserverSetStandardResponse {id, advanced, created\_on, 2 more }

nameservers: Array<Nameserver>

Link to this property

DNSSettingsNameserverSetAdvancedResponse {id, advanced, created\_on, 2 more }

nameservers: Array<Nameserver>

ipv4: Array<string> IPv4 addresses assigned to the nameserver. Link to this property

ipv4\_groups: Array<"a"| "b"| "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.

One of the following: "a" Link to this property "b" Link to this property "c" Link to this property

Link to this property ipv6: Array<string> IPv6 addresses assigned to the nameserver. Link to this property

ipv6\_groups: Array<"a"| "b"| "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.

One of the following: "a" Link to this property "b" Link to this property "c" Link to this property

Link to this property name: string A unique lowercase Punycode nameserver name within the set. Link to this property

Link to this property

[Link to this property](<#(resource)%20dns.settings.account.nameserver_sets%20%3E%20(model)%20nameserver_set_get_response%20%3E%20(schema)>)

NameserverSetCreateResponse = DNSSettingsNameserverSetStandardResponse {id, advanced, created\_on, 2 more } | DNSSettingsNameserverSetAdvancedResponse {id, advanced, created\_on, 2 more }

One of the following:

DNSSettingsNameserverSetStandardResponse {id, advanced, created\_on, 2 more }

nameservers: Array<Nameserver>

Link to this property

DNSSettingsNameserverSetAdvancedResponse {id, advanced, created\_on, 2 more }

nameservers: Array<Nameserver>

ipv4: Array<string> IPv4 addresses assigned to the nameserver. Link to this property

ipv4\_groups: Array<"a"| "b"| "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.

One of the following: "a" Link to this property "b" Link to this property "c" Link to this property

Link to this property ipv6: Array<string> IPv6 addresses assigned to the nameserver. Link to this property

ipv6\_groups: Array<"a"| "b"| "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.

One of the following: "a" Link to this property "b" Link to this property "c" Link to this property

Link to this property name: string A unique lowercase Punycode nameserver name within the set. Link to this property

Link to this property

[Link to this property](<#(resource)%20dns.settings.account.nameserver_sets%20%3E%20(model)%20nameserver_set_create_response%20%3E%20(schema)>)

NameserverSetDeleteResponse {id }

id: string Identifier for a nameserver set. maxLength32 minLength32 Link to this property

[Link to this property](<#(resource)%20dns.settings.account.nameserver_sets%20%3E%20(model)%20nameserver_set_delete_response%20%3E%20(schema)>) #### SettingsAccountViews ##### [List Internal DNS Views](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/views/methods/list) client.dns.settings.account.views.list(ViewListParams {account\_id, direction, match, 6 more } params, RequestOptionsoptions?): V4PagePaginationArray< [ViewListResponse]() {id, created\_time, modified\_time, 2 more } > GET/accounts/{account\_id}/dns\_settings/views ##### [DNS Internal View Details](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/views/methods/get) client.dns.settings.account.views.get(stringviewID, ViewGetParams {account\_id } params, RequestOptionsoptions?): [ViewGetResponse]() {id, created\_time, modified\_time, 2 more } GET/accounts/{account\_id}/dns\_settings/views/{view\_id} ##### [Create Internal DNS View](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/views/methods/create) client.dns.settings.account.views.create(ViewCreateParams {account\_id, name, zones } params, RequestOptionsoptions?): [ViewCreateResponse]() {id, created\_time, modified\_time, 2 more } POST/accounts/{account\_id}/dns\_settings/views ##### [Update Internal DNS View](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/views/methods/edit) client.dns.settings.account.views.edit(stringviewID, ViewEditParams {account\_id, name, zones } params, RequestOptionsoptions?): [ViewEditResponse]() {id, created\_time, modified\_time, 2 more } PATCH/accounts/{account\_id}/dns\_settings/views/{view\_id} ##### [Delete Internal DNS View](https://developers.cloudflare.com/api/typescript/resources/dns/subresources/settings/subresources/account/subresources/views/methods/delete) client.dns.settings.account.views.delete(stringviewID, ViewDeleteParams {account\_id } params, RequestOptionsoptions?): [ViewDeleteResponse]() {id } DELETE/accounts/{account\_id}/dns\_settings/views/{view\_id} ##### ModelsExpand Collapse

ViewListResponse {id, created\_time, modified\_time, 2 more }

id: string Identifier. maxLength32 Link to this property created\_time: string When the view was created. formatdate-time Link to this property modified\_time: string When the view was last modified. formatdate-time Link to this property name: string The name of the view. maxLength255 minLength1 Link to this property zones: Array<string> The list of zones linked to this view. Link to this property

[Link to this property](<#(resource)%20dns.settings.account.views%20%3E%20(model)%20view_list_response%20%3E%20(schema)>)

ViewGetResponse {id, created\_time, modified\_time, 2 more }

[Link to this property](<#(resource)%20dns.settings.account.views%20%3E%20(model)%20view_get_response%20%3E%20(schema)>)

ViewCreateResponse {id, created\_time, modified\_time, 2 more }

[Link to this property](<#(resource)%20dns.settings.account.views%20%3E%20(model)%20view_create_response%20%3E%20(schema)>)

ViewEditResponse {id, created\_time, modified\_time, 2 more }

[Link to this property](<#(resource)%20dns.settings.account.views%20%3E%20(model)%20view_edit_response%20%3E%20(schema)>)

ViewDeleteResponse {id }

id?: string Identifier. maxLength32 Link to this property

[Link to this property](<#(resource)%20dns.settings.account.views%20%3E%20(model)%20view_delete_response%20%3E%20(schema)>)