Skip to content
Cloudflare API
Start here
API Reference
DNS

Settings

SettingsZone

Show DNS Settings
dns.settings.zone.get(ZoneGetParams**kwargs) -> ZoneGetResponse
GET/zones/{zone_id}/dns_settings
Update DNS Settings
dns.settings.zone.edit(ZoneEditParams**kwargs) -> ZoneEditResponse
PATCH/zones/{zone_id}/dns_settings
ModelsExpand Collapse
class ZoneGetResponse: …
flatten_all_cnames: bool

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: bool

Whether to enable Foundation DNS Advanced Nameservers on the zone.

internal_dns: InternalDNS

Settings for this internal zone.

reference_zone_id: Optional[str]

The ID of the zone to fallback to.

multi_provider: bool

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: Nameservers

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

type: Literal["cloudflare.standard", "custom.account", "custom.tenant", "custom.zone"]

Nameserver type

One of the following:
"cloudflare.standard"
"custom.account"
"custom.tenant"
"custom.zone"
ns_set: Optional[int]

Configured nameserver set to be used for this zone

maximum5
minimum1
ns_ttl: float

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

maximum86400
minimum30
secondary_overrides: bool

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

soa: SOA

Components of the zone's SOA record.

expire: Optional[float]

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[float]

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

maximum86400
minimum60
mname: Optional[str]

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

refresh: Optional[float]

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[float]

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

maximum86400
minimum600
rname: Optional[str]

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

ttl: Optional[float]

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

maximum86400
minimum300
zone_mode: Literal["standard", "cdn_only", "dns_only"]

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

One of the following:
"standard"
"cdn_only"
"dns_only"
class ZoneEditResponse: …
flatten_all_cnames: bool

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: bool

Whether to enable Foundation DNS Advanced Nameservers on the zone.

internal_dns: InternalDNS

Settings for this internal zone.

reference_zone_id: Optional[str]

The ID of the zone to fallback to.

multi_provider: bool

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: Nameservers

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

type: Literal["cloudflare.standard", "custom.account", "custom.tenant", "custom.zone"]

Nameserver type

One of the following:
"cloudflare.standard"
"custom.account"
"custom.tenant"
"custom.zone"
ns_set: Optional[int]

Configured nameserver set to be used for this zone

maximum5
minimum1
ns_ttl: float

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

maximum86400
minimum30
secondary_overrides: bool

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

soa: SOA

Components of the zone's SOA record.

expire: Optional[float]

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[float]

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

maximum86400
minimum60
mname: Optional[str]

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

refresh: Optional[float]

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[float]

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

maximum86400
minimum600
rname: Optional[str]

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

ttl: Optional[float]

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

maximum86400
minimum300
zone_mode: Literal["standard", "cdn_only", "dns_only"]

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

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

SettingsAccount

Show DNS Settings
dns.settings.account.get(AccountGetParams**kwargs) -> AccountGetResponse
GET/accounts/{account_id}/dns_settings
Update DNS Settings
dns.settings.account.edit(AccountEditParams**kwargs) -> AccountEditResponse
PATCH/accounts/{account_id}/dns_settings
ModelsExpand Collapse
class AccountGetResponse: …
zone_defaults: ZoneDefaults
flatten_all_cnames: bool

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: bool

Whether to enable Foundation DNS Advanced Nameservers on the zone.

internal_dns: ZoneDefaultsInternalDNS

Settings for this internal zone.

reference_zone_id: Optional[str]

The ID of the zone to fallback to.

multi_provider: bool

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: ZoneDefaultsNameservers

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

type: Literal["cloudflare.standard", "cloudflare.standard.random", "custom.account", "custom.tenant"]

Nameserver type

One of the following:
"cloudflare.standard"
"cloudflare.standard.random"
"custom.account"
"custom.tenant"
ns_ttl: float

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

maximum86400
minimum30
secondary_overrides: bool

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

soa: ZoneDefaultsSOA

Components of the zone's SOA record.

expire: Optional[float]

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[float]

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

maximum86400
minimum60
mname: Optional[str]

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

refresh: Optional[float]

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[float]

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

maximum86400
minimum600
rname: Optional[str]

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

ttl: Optional[float]

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

maximum86400
minimum300
zone_mode: Literal["standard", "cdn_only", "dns_only"]

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

One of the following:
"standard"
"cdn_only"
"dns_only"
class AccountEditResponse: …
zone_defaults: ZoneDefaults
flatten_all_cnames: bool

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: bool

Whether to enable Foundation DNS Advanced Nameservers on the zone.

internal_dns: ZoneDefaultsInternalDNS

Settings for this internal zone.

reference_zone_id: Optional[str]

The ID of the zone to fallback to.

multi_provider: bool

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: ZoneDefaultsNameservers

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

type: Literal["cloudflare.standard", "cloudflare.standard.random", "custom.account", "custom.tenant"]

Nameserver type

One of the following:
"cloudflare.standard"
"cloudflare.standard.random"
"custom.account"
"custom.tenant"
ns_ttl: float

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

maximum86400
minimum30
secondary_overrides: bool

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

soa: ZoneDefaultsSOA

Components of the zone's SOA record.

expire: Optional[float]

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[float]

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

maximum86400
minimum60
mname: Optional[str]

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

refresh: Optional[float]

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[float]

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

maximum86400
minimum600
rname: Optional[str]

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

ttl: Optional[float]

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

maximum86400
minimum300
zone_mode: Literal["standard", "cdn_only", "dns_only"]

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

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

SettingsAccountViews

List Internal DNS Views
dns.settings.account.views.list(ViewListParams**kwargs) -> SyncV4PagePaginationArray[ViewListResponse]
GET/accounts/{account_id}/dns_settings/views
DNS Internal View Details
dns.settings.account.views.get(strview_id, ViewGetParams**kwargs) -> ViewGetResponse
GET/accounts/{account_id}/dns_settings/views/{view_id}
Create Internal DNS View
dns.settings.account.views.create(ViewCreateParams**kwargs) -> ViewCreateResponse
POST/accounts/{account_id}/dns_settings/views
Update Internal DNS View
dns.settings.account.views.edit(strview_id, ViewEditParams**kwargs) -> ViewEditResponse
PATCH/accounts/{account_id}/dns_settings/views/{view_id}
Delete Internal DNS View
dns.settings.account.views.delete(strview_id, ViewDeleteParams**kwargs) -> ViewDeleteResponse
DELETE/accounts/{account_id}/dns_settings/views/{view_id}
ModelsExpand Collapse
class ViewListResponse: …
id: str

Identifier.

maxLength32
created_time: datetime

When the view was created.

formatdate-time
modified_time: datetime

When the view was last modified.

formatdate-time
name: str

The name of the view.

maxLength255
minLength1
zones: List[str]

The list of zones linked to this view.

class ViewGetResponse: …
id: str

Identifier.

maxLength32
created_time: datetime

When the view was created.

formatdate-time
modified_time: datetime

When the view was last modified.

formatdate-time
name: str

The name of the view.

maxLength255
minLength1
zones: List[str]

The list of zones linked to this view.

class ViewCreateResponse: …
id: str

Identifier.

maxLength32
created_time: datetime

When the view was created.

formatdate-time
modified_time: datetime

When the view was last modified.

formatdate-time
name: str

The name of the view.

maxLength255
minLength1
zones: List[str]

The list of zones linked to this view.

class ViewEditResponse: …
id: str

Identifier.

maxLength32
created_time: datetime

When the view was created.

formatdate-time
modified_time: datetime

When the view was last modified.

formatdate-time
name: str

The name of the view.

maxLength255
minLength1
zones: List[str]

The list of zones linked to this view.

class ViewDeleteResponse: …
id: Optional[str]

Identifier.

maxLength32