Skip to content
Cloudflare API
Start here
API Reference
Email Routing

DNS

Email Routing - DNS settings
client.emailRouting.dns.get(DNSGetParams { zone_id, subdomain } params, RequestOptionsoptions?): DNSGetResponse { content, name, priority, 2 more }
GET/zones/{zone_id}/email/routing/dns
Enable Email Routing
client.emailRouting.dns.create(DNSCreateParams { zone_id, name } params, RequestOptionsoptions?): Settings { id, enabled, name, 6 more }
POST/zones/{zone_id}/email/routing/dns
Unlock Email Routing
client.emailRouting.dns.edit(DNSEditParams { zone_id, name } params, RequestOptionsoptions?): Settings { id, enabled, name, 6 more }
PATCH/zones/{zone_id}/email/routing/dns
Disable Email Routing
client.emailRouting.dns.delete(DNSDeleteParams { zone_id } params, RequestOptionsoptions?): Settings { id, enabled, name, 6 more }
DELETE/zones/{zone_id}/email/routing/dns
ModelsExpand Collapse
DNSRecord { content, name, priority, 2 more }

List of records needed to enable an Email Routing zone.

content?: string

DNS record content.

name?: string

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

maxLength255
priority?: number

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

maximum65535
minimum0
ttl?: number | 1

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

One of the following:
number
1
1
type?: "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"
DNSGetResponse = Array<DNSRecord { content, name, priority, 2 more } >
content?: string

DNS record content.

name?: string

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

maxLength255
priority?: number

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

maximum65535
minimum0
ttl?: number | 1

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

One of the following:
number
1
1
type?: "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"