Overview

Namespaces

  • Cloudflare
    • Organizations
      • Firewall
        • AccessRules
    • User
      • Billing
        • Subscriptions
      • Firewall
    • Zone
      • Firewall
      • SSL
      • WAF
        • Packages

Classes

  • Groups
  • Rules
  • Overview
  • Namespace
  • Class

Class Groups

CloudFlare API wrapper

WAF Rule Groups properties

Cloudflare\Api
Extended by Cloudflare\Zone\WAF\Packages\Groups
Namespace: Cloudflare\Zone\WAF\Packages
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/Zone/WAF/Packages/Groups.php
Methods summary
public
# groups( string $zone_identifier, string $package_identifier, string|null $name = null, string|null $mode = null, integer|null $rules_count = null, integer|null $page = null, integer|null $per_page = null, string|null $order = null, string|null $direction = null, string|null $match = null )

List rule groups (permission needed: #zone:read) Search, list, and sort rule groups contained within a package

List rule groups (permission needed: #zone:read) Search, list, and sort rule groups contained within a package

Parameters

$zone_identifier
$package_identifier
$name
Name of the firewall rule group
$mode
Whether or not the rules contained within this group are configurable/usable
$rules_count
How many rules are contained within this group
$page
Page number of paginated results
$per_page
Number of groups per page
$order
Field to order groups by
$direction
Direction to order groups
$match
Whether to match all search requirements or at least one (any)
public
# info( string $zone_identifier, string $package_identifier, string $identifier )

Rule group info (permission needed: #zone:read) Get a single rule group

Rule group info (permission needed: #zone:read) Get a single rule group

Parameters

$zone_identifier
$package_identifier
$identifier
public
# update( string $zone_identifier, string $package_identifier, string $identifier, string|null $mode = null )

Update Rule group (permission needed: #zone:edit) Update the state of a rule group

Update Rule group (permission needed: #zone:edit) Update the state of a rule group

Parameters

$zone_identifier
$package_identifier
$identifier
$mode
Whether or not the rules contained within this group are configurable/usable
Methods inherited from Cloudflare\Api
__construct(), delete(), get(), patch(), permissions(), post(), put(), request(), setAuthKey(), setCurlOption(), setEmail()
Properties summary
protected array $permission_level

Default permissions level

Default permissions level

# ['read' => '#zone:read', 'edit' => '#zone:edit']
Properties inherited from Cloudflare\Api
$auth_key, $curl_options, $email
API documentation generated by ApiGen