PHP Class Cloudflare\Zone\WAF\Packages\Rules

WAF Rules properties
Author: James Bell ([email protected])
Inheritance: extends CloudFlare\Api
Exibir arquivo Open project: jamesryanbell/cloudflare

Public Methods

Method Description
info ( string $zone_id, string $package_id, string $identifier ) Rule info (permission needed: #zone:read) Individual information about a rule
rules ( string $zone_id, string $package_id, string | null $description = null, object | null $mode = null, integer | null $priority = null, string | null $group_id = null, integer | null $page = null, integer | null $per_page = null, string | null $order = null, string | null $direction = null, string | null $match = null ) List rule (permission needed: #zone:read) Search, list, and filter rules within a package
update ( string $zone_id, string $package_id, string $identifier, string | null $mode = null ) Update Rule group (permission needed: #zone:edit) Update the state of a rule group

Method Details

info() public method

Rule info (permission needed: #zone:read) Individual information about a rule
public info ( string $zone_id, string $package_id, string $identifier )
$zone_id string
$package_id string
$identifier string

rules() public method

List rule (permission needed: #zone:read) Search, list, and filter rules within a package
public rules ( string $zone_id, string $package_id, string | null $description = null, object | null $mode = null, integer | null $priority = null, string | null $group_id = null, integer | null $page = null, integer | null $per_page = null, string | null $order = null, string | null $direction = null, string | null $match = null )
$zone_id string
$package_id string
$description string | null Public description of the rule
$mode object | null The rule mode
$priority integer | null The order in which the individual rule is executed within the related group
$group_id string | null WAF group identifier tag
$page integer | null Page number of paginated results
$per_page integer | null Number of rules per page
$order string | null Field to order rules by
$direction string | null Direction to order rules
$match string | null Whether to match all search requirements or at least one (any)

update() public method

Update Rule group (permission needed: #zone:edit) Update the state of a rule group
public update ( string $zone_id, string $package_id, string $identifier, string | null $mode = null )
$zone_id string
$package_id string
$identifier string
$mode string | null The mode to use when the rule is triggered. Value is restricted based on the allowed_modes of the rule