Cloudflare API | Email Routing

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Get Email Routing settings

Disable Email Routing

Enable Email Routing

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

R2 Data Catalog

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Email Routing

EmailRouting

Methods

client.emailRouting.get(, ):

get/zones/{zone_id}/email/routing

Get information about the settings for your Email Routing zone.

client.emailRouting.disable(, ):

Deprecated

post/zones/{zone_id}/email/routing/disable

Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.

client.emailRouting.enable(, ):

Deprecated

post/zones/{zone_id}/email/routing/enable

Enable you Email Routing zone. Add and lock the necessary MX and SPF records.

Domain types

Settings{…}

Addresses

EmailRouting.Addresses

Methods

client.emailRouting.addresses.list(, ):

V4PagePaginationArray

<

>

get/accounts/{account_id}/email/routing/addresses

Lists existing destination addresses.

client.emailRouting.addresses.get(, , ):

get/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}

Gets information for a specific destination email already created.

client.emailRouting.addresses.create(, ):

post/accounts/{account_id}/email/routing/addresses

Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.

client.emailRouting.addresses.delete(, , ):

delete/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}

Deletes a specific destination address.

Domain types

Address{…}

DNS

EmailRouting.DNS

Methods

client.emailRouting.dns.get(, ):

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

Show the DNS records needed to configure your Email Routing zone.

client.emailRouting.dns.create(, ):

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

Enable you Email Routing zone. Add and lock the necessary MX and SPF records.

client.emailRouting.dns.edit(, ):

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

Unlock MX Records previously locked by Email Routing.

client.emailRouting.dns.delete(, ):

<

>

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

Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.

Domain types

DNSRecord{…}

List of records needed to enable an Email Routing zone.

Rules

EmailRouting.Rules

Methods

client.emailRouting.rules.list(, ):

V4PagePaginationArray

<

EmailRoutingRule

>

get/zones/{zone_id}/email/routing/rules

Lists existing routing rules.

client.emailRouting.rules.get(, , ):

EmailRoutingRule

get/zones/{zone_id}/email/routing/rules/{rule_identifier}

Get information for a specific routing rule already created.

client.emailRouting.rules.create(, ):

EmailRoutingRule

post/zones/{zone_id}/email/routing/rules

Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address).

client.emailRouting.rules.update(, , ):

EmailRoutingRule

put/zones/{zone_id}/email/routing/rules/{rule_identifier}

Update actions and matches, or enable/disable specific routing rules.

client.emailRouting.rules.delete(, , ):

EmailRoutingRule

delete/zones/{zone_id}/email/routing/rules/{rule_identifier}

Delete a specific routing rule.

Domain types

Action{…}

Actions pattern.

EmailRoutingRule{…}

Matcher{…}

Matching pattern to forward your actions.

Email Routing Rules

Catch Alls

EmailRouting.Rules.CatchAlls

Methods

client.emailRouting.rules.catchAlls.get(, ):

CatchAllGetResponse

get/zones/{zone_id}/email/routing/rules/catch_all

Get information on the default catch-all routing rule.

client.emailRouting.rules.catchAlls.update(, ):

CatchAllUpdateResponse

put/zones/{zone_id}/email/routing/rules/catch_all

Enable or disable catch-all routing rule, or change action to forward to specific destination address.

Domain types

CatchAllAction{…}

Action for the catch-all routing rule.

CatchAllMatcher{…}

Matcher for catch-all routing rule.