API Reference

Email Routing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

DNS

Email Routing - DNS settings

GET/zones/{zone_id}/email/routing/dns

Enable Email Routing

POST/zones/{zone_id}/email/routing/dns

Unlock Email Routing

PATCH/zones/{zone_id}/email/routing/dns

Disable Email Routing

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: optional string

DNS record content.

name: optional string

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

maxLength255

priority: optional number

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

maximum65535

minimum0

ttl: optional number or 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

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

type: optional "A" or "AAAA" or "CNAME" or 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 = { errors, messages, success, 2 more } or { errors, messages, success, 2 more }

One of the following:

EmailEmailRoutingDNSQueryResponse { errors, messages, success, 2 more }

errors: array of { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

messages: array of { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result: optional { errors, record }

errors: optional array of { code, missing }

code: optional string

missing: optional DNSRecord { content, name, priority, 2 more }

List of records needed to enable an Email Routing zone.

record: optional array of DNSRecord { content, name, priority, 2 more }

content: optional string

DNS record content.

name: optional string

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

maxLength255

priority: optional number

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

maximum65535

minimum0

ttl: optional number or 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

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

type: optional "A" or "AAAA" or "CNAME" or 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 { count, page, per_page, 2 more }

count: optional number

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

total_pages: optional number

The number of total pages in the entire result set.

EmailDNSSettingsResponseCollection { errors, messages, success, 2 more }

errors: array of { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

messages: array of { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

success: true

Whether the API call was successful.

result: optional array of DNSRecord { content, name, priority, 2 more }

content: optional string

DNS record content.

name: optional string

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

maxLength255

priority: optional number

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

maximum65535

minimum0

ttl: optional number or 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

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

type: optional "A" or "AAAA" or "CNAME" or 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 { count, page, per_page, 2 more }

count: optional number

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

total_pages: optional number

The number of total pages in the entire result set.