Get a firewall rule

Fetches the details of a firewall rule.

Responses

🟢200Get a firewall rule response

application/json

Body

result

required

Any of

filter-rule-response

allOf {3}

action

enum<string>

firewall-rules_components-schemas-action

optional

The action to apply to a matched request. The log action is only available on an Enterprise plan.

Allowed values:

blockchallengejs_challengemanaged_challengeallowlogbypass

Example:

block

description

string

firewall-rules_components-schemas-description

optional

An informative summary of the firewall rule.

<= 500 characters

Example:

Blocks traffic identified during investigation for MIR-31

string

firewall-rules_components-schemas-id

read-onlyoptional

The unique identifier of the firewall rule.

<= 32 characters

Example:

372e67954025e0ba6aaa6d586b9e0b60

paused

boolean

firewall-rules_components-schemas-paused

optional

When true, indicates that the firewall rule is currently paused.

Example:

false

priority

number

firewall-rules_components-schemas-priority

optional

The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.

>= 0<= 2147483647

Example:

products

array[string]

products

optional

Allowed values:

zoneLockdownuaBlockbichotsecurityLevelrateLimitwaf

ref

string

ref

optional

A short reference tag. Allows you to select related firewall rules.

<= 50 characters

Example:

MIR-31

filter

optional

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": {
        "action": "block",
        "description": "Blocks traffic identified during investigation for MIR-31",
        "id": "372e67954025e0ba6aaa6d586b9e0b60",
        "paused": false,
        "priority": 50,
        "products": [
            "waf"
        ],
        "ref": "MIR-31",
        "filter": {
            "description": "Restrict access from these browsers on this address range.",
            "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
            "id": "372e67954025e0ba6aaa6d586b9e0b61",
            "paused": false,
            "ref": "FIL-100"
        }
    },
    "success": true
}

🟢200Get a firewall rule response failure

Request

Request samples

Responses