List WAF rule groups

Deprecated

client.firewall.waf.packages.groups.list(, , ?): V4PagePaginationArray<Group { id, description, mode, 5 more } >

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

Fetches the WAF rule groups in a WAF package.

Note: Applies only to the previous version of WAF managed rules.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Firewall Services WriteFirewall Services Read

ParametersExpand Collapse

packageID: string

Defines the unique identifier of a WAF package.

maxLength32

params: GroupListParams { zone_id, direction, match, 6 more }

zone_id: string

Path param: Defines an identifier of a schema.

maxLength32

direction?: "asc" | "desc"

Query param: Defines the direction used to sort returned rule groups.

One of the following:

"asc"

"desc"

match?: "any" | "all"

Query param: Defines the condition for search requirements. When set to all, all the search requirements must match. When set to any, only one of the search requirements has to match.

One of the following:

"any"

"all"

mode?: "on" | "off"

Query param: 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

Query param: Defines the name of the rule group.

order?: "mode" | "rules_count"

Query param: Defines the field used to sort returned rule groups.

One of the following:

"mode"

"rules_count"

page?: number

Query param: Defines the page number of paginated results.

minimum1

per_page?: number

Query param: Defines the number of rule groups per page.

maximum100

minimum5

rules_count?: number

Query param: Defines the number of rules in the current rule group.

ReturnsExpand 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

List WAF rule groups

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const group of client.firewall.waf.packages.groups.list(
  'a25a9a7e9c00afc1fb2e0245519d725b',
  { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
)) {
  console.log(group.id);
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "de677e5818985db1285d0e80225f06e5",
      "description": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
      "mode": "on",
      "name": "Project Honey Pot",
      "rules_count": 10,
      "allowed_modes": [
        "on",
        "off"
      ],
      "modified_rules_count": 2,
      "package_id": "a25a9a7e9c00afc1fb2e0245519d725b"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "de677e5818985db1285d0e80225f06e5",
      "description": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
      "mode": "on",
      "name": "Project Honey Pot",
      "rules_count": 10,
      "allowed_modes": [
        "on",
        "off"
      ],
      "modified_rules_count": 2,
      "package_id": "a25a9a7e9c00afc1fb2e0245519d725b"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}