Overview

Namespaces

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

Classes

  • Groups
  • Rules
  • Overview
  • Namespace
  • Class

Class Rules

CloudFlare API wrapper

WAF Rules properties

Cloudflare\Api
Extended by Cloudflare\Zone\WAF\Packages\Rules
Namespace: Cloudflare\Zone\WAF\Packages
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/Zone/WAF/Packages/Rules.php
Methods summary
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 )

List rule (permission needed: #zone:read) Search, list, and filter rules within a package

List rule (permission needed: #zone:read) Search, list, and filter rules within a package

Parameters

$zone_id
$package_id
$description
Public description of the rule
$mode
The rule mode
$priority
The order in which the individual rule is executed within the related group
$group_id
WAF group identifier tag
$page
Page number of paginated results
$per_page
Number of rules per page
$order
Field to order rules by
$direction
Direction to order rules
$match
Whether to match all search requirements or at least one (any)
public
# info( string $zone_id, string $package_id, string $identifier )

Rule info (permission needed: #zone:read) Individual information about a rule

Rule info (permission needed: #zone:read) Individual information about a rule

Parameters

$zone_id
$package_id
$identifier
public
# 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

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

Parameters

$zone_id
$package_id
$identifier
$mode
The mode to use when the rule is triggered. Value is restricted based on the allowed_modes of the rule
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