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

client.emailRouting.dns.get(DNSGetParams { zone_id, subdomain } params, RequestOptionsoptions?): DNSGetResponse

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

Enable Email Routing

client.emailRouting.dns.create(DNSCreateParams { zone_id, name } params, RequestOptionsoptions?): Settings { id, enabled, name, 5 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, 5 more }

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

Disable Email Routing

client.emailRouting.dns.delete(DNSDeleteParams { zone_id } params, RequestOptionsoptions?): SinglePage<DNSRecord { content, name, priority, 2 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

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 = EmailEmailRoutingDNSQueryResponse { errors, messages, success, 2 more } | EmailDNSSettingsResponseCollection { errors, messages, success, 2 more }

One of the following:

EmailEmailRoutingDNSQueryResponse { errors, messages, success, 2 more }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result?: Result { errors, record }

errors?: Array<Error>

code?: string

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

List of records needed to enable an Email Routing zone.

record?: 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

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"

result_info?: ResultInfo { count, page, per_page, 2 more }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

total_pages?: number

The number of total pages in the entire result set.

EmailDNSSettingsResponseCollection { errors, messages, success, 2 more }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

result?: 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

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"

result_info?: ResultInfo { count, page, per_page, 2 more }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

total_pages?: number

The number of total pages in the entire result set.