Cloudflare

Get catch-all rule

GET

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/email/routing/rules/catch_all

Email Routing routing rules

Last modified:2022-12-16 13:48:33

Get information on the default catch-all routing rule.

Request

Path Params

zone_identifier

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get catch-all rule response

application/json

Body

actions

array[object (catchall-action) {2}]

optional

List actions for the catch-all routing rule.

type

enum<string>

required

Type of action for catch-all rule.

Allowed values:

dropforwardworker

Example:

forward

value

array[string]

optional

enabled

enum<boolean>

optional

Routing rule status.

Allowed values:

truefalse

Default:

true

Example:

true

matchers

array[object (catchall-matcher) {1}]

optional

List of matchers for the catch-all routing rule.

type

enum<string>

required

Type of matcher. Default is 'all'.

Allowed value:

all

Example:

all

name

string

optional

Routing rule name.

<= 256 characters

Example:

Send to user@example.net rule.

tag

string

read-onlyoptional

Routing rule identifier.

<= 32 characters

Example:

a7e6fb77503c41d8a7f3113c6918f10c

Example

{
  "actions": [
    {
      "type": "forward",
      "value": [
        "destinationaddress@example.net"
      ]
    }
  ],
  "enabled": true,
  "matchers": [
    {
      "type": "all"
    }
  ],
  "name": "Send to user@example.net rule.",
  "tag": "a7e6fb77503c41d8a7f3113c6918f10c"
}

🟢200Get catch-all rule response failure

Create routing rule

Update catch-all rule