List routing rules

Lists existing routing rules.

application/json

Body

result

required

Any of

allOf {2}

array[object (rules) {6}]

allOf {2}

One of

array[object (rules) {6}]

object

actions

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

actions

optional

List actions patterns.

enabled

enum<boolean>

rules_components-schemas-enabled

optional

Routing rule status.

Allowed values:

truefalse

Default:

true

Example:

true

matchers

array[object (matcher) {3}]

matchers

optional

Matching patterns to forward to your actions.

name

string

rules_components-schemas-name

optional

Routing rule name.

<= 256 characters

Example:

Send to user@example.net rule.

priority

number

components-schemas-priority

optional

Priority of the routing rule.

>= 0

Default:

tag

string

rule_identifier

read-onlyoptional

Routing rule identifier.

<= 32 characters

Example:

a7e6fb77503c41d8a7f3113c6918f10c

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

null

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "actions": [
                {
                    "type": "forward",
                    "value": [
                        "destinationaddress@example.net"
                    ]
                }
            ],
            "enabled": true,
            "matchers": [
                {
                    "field": "to",
                    "type": "literal",
                    "value": "test@example.com"
                }
            ],
            "name": "Send to user@example.net rule.",
            "priority": 0,
            "tag": "a7e6fb77503c41d8a7f3113c6918f10c"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 1
    }
}

Request

Request samples

Responses