PHP Class Cloudflare\Zone\WAF\Packages\Groups

WAF Rule Groups properties
Author: James Bell ([email protected])
Inheritance: extends CloudFlare\Api
Show file Open project: jamesryanbell/cloudflare

Public Methods

Method Description
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
info ( string $zone_identifier, string $package_identifier, string $identifier ) Rule group info (permission needed: #zone:read) Get a single rule group
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

Method Details

groups() public method

List rule groups (permission needed: #zone:read) Search, list, and sort rule groups contained within a package
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 )
$zone_identifier string
$package_identifier string
$name string | null Name of the firewall rule group
$mode string | null Whether or not the rules contained within this group are configurable/usable
$rules_count integer | null How many rules are contained within this group
$page integer | null Page number of paginated results
$per_page integer | null Number of groups per page
$order string | null Field to order groups by
$direction string | null Direction to order groups
$match string | null Whether to match all search requirements or at least one (any)

info() public method

Rule group info (permission needed: #zone:read) Get a single rule group
public info ( string $zone_identifier, string $package_identifier, string $identifier )
$zone_identifier string
$package_identifier string
$identifier string

update() public method

Update Rule group (permission needed: #zone:edit) Update the state of a rule group
public update ( string $zone_identifier, string $package_identifier, string $identifier, string | null $mode = null )
$zone_identifier string
$package_identifier string
$identifier string
$mode string | null Whether or not the rules contained within this group are configurable/usable