List WAF rules

Fetches WAF rules in a WAF package.

application/json

Body

result

required

Any of

allOf {2}

array[null (components-schemas-rule) {3}]

allOf {2}

One of

array[null (components-schemas-rule) {3}]

object

Anomaly detection WAF rule

optional

When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.

object

Traditional (deny) WAF rule

optional

When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.

object

Traditional (allow) WAF rule

optional

When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.

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

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:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "description": "SQL injection prevention for SELECT statements",
            "group": {
                "id": "de677e5818985db1285d0e80225f06e5",
                "name": "Project Honey Pot"
            },
            "id": "f939de3be84e66e757adcdcb87908023",
            "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
            "priority": "string",
            "allowed_modes": [
                "on",
                "off"
            ],
            "mode": "on"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses