API Reference

Firewall

WAF

Packages

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Groups

List WAF rule groups

Deprecated

client.firewall.waf.packages.groups.list(stringpackageId, GroupListParams { zone_id, direction, match, 6 more } params, RequestOptionsoptions?): V4PagePaginationArray<Group { id, description, mode, 5 more } >

GET/zones/{zone_id}/firewall/waf/packages/{package_id}/groups

Get a WAF rule group

Deprecated

client.firewall.waf.packages.groups.get(stringpackageId, stringgroupId, GroupGetParams { zone_id } params, RequestOptionsoptions?): GroupGetResponse

GET/zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}

Update a WAF rule group

Deprecated

client.firewall.waf.packages.groups.edit(stringpackageId, stringgroupId, GroupEditParams { zone_id, mode } params, RequestOptionsoptions?): GroupEditResponse

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 | null

Defines an informative summary of what the rule group does.

mode: "on" | "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?: Array<"on" | "off">

Defines the available states for the rule group.

One of the following:

"on"

"off"

modified_rules_count?: number

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

package_id?: string

Defines the unique identifier of a WAF package.

maxLength32

GroupGetResponse = unknown | string | null

One of the following:

unknown

string | null

GroupEditResponse = unknown | string | null

One of the following:

unknown

string | null