Skip to content
Cloudflare API
Start here
API Reference
Email Routing

DNS

Email Routing - DNS settings
email_routing.dns.get(DNSGetParams**kwargs) -> DNSGetResponse
GET/zones/{zone_id}/email/routing/dns
Enable Email Routing
email_routing.dns.create(DNSCreateParams**kwargs) -> Settings
POST/zones/{zone_id}/email/routing/dns
Unlock Email Routing
email_routing.dns.edit(DNSEditParams**kwargs) -> Settings
PATCH/zones/{zone_id}/email/routing/dns
Disable Email Routing
email_routing.dns.delete(DNSDeleteParams**kwargs) -> SyncSinglePage[DNSRecord]
DELETE/zones/{zone_id}/email/routing/dns
ModelsExpand Collapse
class DNSRecord: …

List of records needed to enable an Email Routing zone.

content: Optional[str]

DNS record content.

name: Optional[str]

DNS record name (or @ for the zone apex).

maxLength255
priority: Optional[float]

Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.

maximum65535
minimum0
ttl: Optional[Union[float, Literal[1], null]]

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.

One of the following:
float
Literal[1]

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.

type: Optional[Literal["A", "AAAA", "CNAME", 15 more]]

DNS record type.

One of the following:
"A"
"AAAA"
"CNAME"
"HTTPS"
"TXT"
"SRV"
"LOC"
"MX"
"NS"
"CERT"
"DNSKEY"
"DS"
"NAPTR"
"SMIMEA"
"SSHFP"
"SVCB"
"TLSA"
"URI"
One of the following:
class EmailEmailRoutingDNSQueryResponse: …
errors: List[EmailEmailRoutingDNSQueryResponseError]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[EmailEmailRoutingDNSQueryResponseErrorSource]
pointer: Optional[str]
messages: List[EmailEmailRoutingDNSQueryResponseMessage]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[EmailEmailRoutingDNSQueryResponseMessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result: Optional[EmailEmailRoutingDNSQueryResponseResult]
errors: Optional[List[EmailEmailRoutingDNSQueryResponseResultError]]
code: Optional[str]
missing: Optional[DNSRecord]

List of records needed to enable an Email Routing zone.

record: Optional[List[DNSRecord]]
content: Optional[str]

DNS record content.

name: Optional[str]

DNS record name (or @ for the zone apex).

maxLength255
priority: Optional[float]

Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.

maximum65535
minimum0
ttl: Optional[Union[float, Literal[1], null]]

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.

One of the following:
float
Literal[1]

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.

type: Optional[Literal["A", "AAAA", "CNAME", 15 more]]

DNS record type.

One of the following:
"A"
"AAAA"
"CNAME"
"HTTPS"
"TXT"
"SRV"
"LOC"
"MX"
"NS"
"CERT"
"DNSKEY"
"DS"
"NAPTR"
"SMIMEA"
"SSHFP"
"SVCB"
"TLSA"
"URI"
result_info: Optional[EmailEmailRoutingDNSQueryResponseResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

total_pages: Optional[float]

The number of total pages in the entire result set.

class EmailDNSSettingsResponseCollection: …
errors: List[EmailDNSSettingsResponseCollectionError]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[EmailDNSSettingsResponseCollectionErrorSource]
pointer: Optional[str]
messages: List[EmailDNSSettingsResponseCollectionMessage]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[EmailDNSSettingsResponseCollectionMessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

result: Optional[List[DNSRecord]]
content: Optional[str]

DNS record content.

name: Optional[str]

DNS record name (or @ for the zone apex).

maxLength255
priority: Optional[float]

Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.

maximum65535
minimum0
ttl: Optional[Union[float, Literal[1], null]]

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.

One of the following:
float
Literal[1]

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.

type: Optional[Literal["A", "AAAA", "CNAME", 15 more]]

DNS record type.

One of the following:
"A"
"AAAA"
"CNAME"
"HTTPS"
"TXT"
"SRV"
"LOC"
"MX"
"NS"
"CERT"
"DNSKEY"
"DS"
"NAPTR"
"SMIMEA"
"SSHFP"
"SVCB"
"TLSA"
"URI"
result_info: Optional[EmailDNSSettingsResponseCollectionResultInfo]
count: Optional[float]

Total number of results for the requested service.

page: Optional[float]

Current page within paginated list of results.

per_page: Optional[float]

Number of results per page of results.

total_count: Optional[float]

Total results available without any search parameters.

total_pages: Optional[float]

The number of total pages in the entire result set.