Skip to content
Start here

Groups

List WAF rule groups
Deprecated
GET/zones/{zone_id}/firewall/waf/packages/{package_id}/groups
Get a WAF rule group
Deprecated
GET/zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}
Update a WAF rule group
Deprecated
PATCH/zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}
ModelsExpand Collapse
Group { id, description, mode, 5 more }
id: string

Defines the unique identifier of the rule group.

maxLength32
description: string

Defines an informative summary of what the rule group does.

mode: "on" or "off"

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

One of the following:
"on"
"off"
name: string

Defines the name of the rule group.

rules_count: number

Defines the number of rules in the current rule group.

allowed_modes: optional array of "on" or "off"

Defines the available states for the rule group.

One of the following:
"on"
"off"
modified_rules_count: optional number

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

package_id: optional string

Defines the unique identifier of a WAF package.

maxLength32
GroupGetResponse = unknown or string
One of the following:
unknown
string
GroupEditResponse = unknown or string
One of the following:
unknown
string