Skip to content
Cloudflare API
Start here
API Reference
Email Routing

Rules

List routing rules
email_routing.rules.list(RuleListParams**kwargs) -> SyncV4PagePaginationArray[EmailRoutingRule]
GET/zones/{zone_id}/email/routing/rules
Get routing rule
email_routing.rules.get(strrule_identifier, RuleGetParams**kwargs) -> EmailRoutingRule
GET/zones/{zone_id}/email/routing/rules/{rule_identifier}
Create routing rule
email_routing.rules.create(RuleCreateParams**kwargs) -> EmailRoutingRule
POST/zones/{zone_id}/email/routing/rules
Update routing rule
email_routing.rules.update(strrule_identifier, RuleUpdateParams**kwargs) -> EmailRoutingRule
PUT/zones/{zone_id}/email/routing/rules/{rule_identifier}
Delete routing rule
email_routing.rules.delete(strrule_identifier, RuleDeleteParams**kwargs) -> EmailRoutingRule
DELETE/zones/{zone_id}/email/routing/rules/{rule_identifier}
ModelsExpand Collapse
class Action: …

Actions pattern.

type: Literal["drop", "forward", "worker"]

Type of supported action.

One of the following:
"drop"
"forward"
"worker"
value: Optional[List[str]]
class EmailRoutingRule: …
id: Optional[str]

Routing rule identifier.

maxLength32
actions: Optional[List[Action]]

List actions patterns.

type: Literal["drop", "forward", "worker"]

Type of supported action.

One of the following:
"drop"
"forward"
"worker"
value: Optional[List[str]]
enabled: Optional[Literal[true, false]]

Routing rule status.

One of the following:
true
false
matchers: Optional[List[Matcher]]

Matching patterns to forward to your actions.

type: Literal["all", "literal"]

Type of matcher.

One of the following:
"all"
"literal"
field: Optional[Literal["to"]]

Field for type matcher.

value: Optional[str]

Value for matcher.

maxLength90
name: Optional[str]

Routing rule name.

maxLength256
priority: Optional[float]

Priority of the routing rule.

minimum0
Deprecatedtag: Optional[str]

Routing rule tag. (Deprecated, replaced by routing rule identifier)

maxLength32
class Matcher: …

Matching pattern to forward your actions.

type: Literal["all", "literal"]

Type of matcher.

One of the following:
"all"
"literal"
field: Optional[Literal["to"]]

Field for type matcher.

value: Optional[str]

Value for matcher.

maxLength90

RulesCatch Alls

Get catch-all rule
email_routing.rules.catch_alls.get(CatchAllGetParams**kwargs) -> CatchAllGetResponse
GET/zones/{zone_id}/email/routing/rules/catch_all
Update catch-all rule
email_routing.rules.catch_alls.update(CatchAllUpdateParams**kwargs) -> CatchAllUpdateResponse
PUT/zones/{zone_id}/email/routing/rules/catch_all
ModelsExpand Collapse
class CatchAllAction: …

Action for the catch-all routing rule.

type: Literal["drop", "forward", "worker"]

Type of action for catch-all rule.

One of the following:
"drop"
"forward"
"worker"
value: Optional[List[str]]
class CatchAllMatcher: …

Matcher for catch-all routing rule.

type: Literal["all"]

Type of matcher. Default is 'all'.

class CatchAllGetResponse: …
id: Optional[str]

Routing rule identifier.

maxLength32
actions: Optional[List[CatchAllAction]]

List actions for the catch-all routing rule.

type: Literal["drop", "forward", "worker"]

Type of action for catch-all rule.

One of the following:
"drop"
"forward"
"worker"
value: Optional[List[str]]
enabled: Optional[Literal[true, false]]

Routing rule status.

One of the following:
true
false
matchers: Optional[List[CatchAllMatcher]]

List of matchers for the catch-all routing rule.

type: Literal["all"]

Type of matcher. Default is 'all'.

name: Optional[str]

Routing rule name.

maxLength256
Deprecatedtag: Optional[str]

Routing rule tag. (Deprecated, replaced by routing rule identifier)

maxLength32
class CatchAllUpdateResponse: …
id: Optional[str]

Routing rule identifier.

maxLength32
actions: Optional[List[CatchAllAction]]

List actions for the catch-all routing rule.

type: Literal["drop", "forward", "worker"]

Type of action for catch-all rule.

One of the following:
"drop"
"forward"
"worker"
value: Optional[List[str]]
enabled: Optional[Literal[true, false]]

Routing rule status.

One of the following:
true
false
matchers: Optional[List[CatchAllMatcher]]

List of matchers for the catch-all routing rule.

type: Literal["all"]

Type of matcher. Default is 'all'.

name: Optional[str]

Routing rule name.

maxLength256
Deprecatedtag: Optional[str]

Routing rule tag. (Deprecated, replaced by routing rule identifier)

maxLength32