List WAF rule groups

Fetches the WAF rule groups in a WAF package.

application/json

Body

result

required

Any of

allOf {2}

array[object (schemas-group) {8}]

allOf {2}

One of

array[object (schemas-group) {8}]

object

description

string | null

group_components-schemas-description

read-onlyrequired

An informative summary of what the rule group does.

Example:

Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks

string

group_components-schemas-identifier

read-onlyrequired

The unique identifier of the rule group.

<= 32 characters

Example:

de677e5818985db1285d0e80225f06e5

modified_rules_count

number

modified_rules_count

read-onlyoptional

The number of rules within the group that have been modified from their default configuration.

Default:

Example:

name

string

group_components-schemas-name

read-onlyrequired

The name of the rule group.

Example:

Project Honey Pot

package_id

string

package_components-schemas-identifier

read-onlyoptional

The unique identifier of a WAF package.

<= 32 characters

Example:

a25a9a7e9c00afc1fb2e0245519d725b

rules_count

number

rules_count

read-onlyrequired

The number of rules in the current rule group.

Default:

Example:

allowed_modes

array[string]

allowed_modes

read-onlyoptional

The available states for the rule group.

Allowed values:

onoff

Example:

["on","off"]

mode

enum<string>

components-schemas-mode

required

The state of the rules contained in the rule group. When on, the rules in the group are configurable/usable.

Allowed values:

onoff

Default:

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": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
            "id": "de677e5818985db1285d0e80225f06e5",
            "modified_rules_count": 2,
            "name": "Project Honey Pot",
            "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
            "rules_count": 10,
            "allowed_modes": [
                "on",
                "off"
            ],
            "mode": "on"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List WAF rule groups

Request

Request samples

Responses