Get rule

List a single network monitoring rule for account.

Responses

🟢200Get rule response

application/json

Body

automatic_advertisement

boolean

required

Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit.

Example:

false

bandwidth_threshold

number

optional

The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.

>= 1

Example:

1000

duration

string

required

The amount of time that the rule threshold must be exceeded to send an alert notification. The minimum is 60 seconds and maximum is 21600 seconds. The format is XhYmZs where X, Y, and Z durations are optional; however at least one unit must be provided.

Default:

60s

Example:

1h2m3s

optional

Example:

2890e6fa406311ed9b5a23f70f6fb8cf

name

string

required

The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have a space in the rule name. Max 256 characters.

Example:

my_rule_1

packet_threshold

number

optional

The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.

>= 1

Example:

10000

prefixes

array[string]

required

Example

{
    "automatic_advertisement": "false",
    "bandwidth_threshold": 1000,
    "duration": "1h2m3s",
    "id": "2890e6fa406311ed9b5a23f70f6fb8cf",
    "name": "my_rule_1",
    "packet_threshold": 10000,
    "prefixes": [
        "203.0.113.1/32"
    ]
}

🟢200Get rule response failure

Request

Request samples

Responses