packages_rules

Creates, updates, deletes, gets or lists a packages_rules resource.

Overview

Name	packages_rules
Type	Resource
Id	cloudflare.firewall.packages_rules

Fields

The following fields are returned by SELECT queries:

get_by_zone

Get a WAF rule response.

Name	Datatype	Description
errors	array
messages	array
result	object
success	boolean	Defines whether the API call was successful. (true)

list_by_zone

List WAF rules response.

Name	Datatype	Description
id	string	Defines the unique identifier of the WAF rule. (example: f939de3be84e66e757adcdcb87908023)
package_id	string	Defines the unique identifier of a WAF package. (example: a25a9a7e9c00afc1fb2e0245519d725b)
allowed_modes	array	Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules.
default_mode	string	Defines the default action/mode of a rule. (disable, simulate, block, challenge) (example: block)
description	string	Defines the public description of the WAF rule. (example: SQL injection prevention for SELECT statements)
group	object	Defines the rule group to which the current WAF rule belongs.
mode	string	Defines the mode anomaly. When set to on, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules. (on, off) (example: on)
priority	string	Defines the order in which the individual WAF rule is executed within its rule group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_zone	select	rule_id, package_id, zone_id		Fetches the details of a WAF rule in a WAF package. Note: Applies only to the previous version of WAF managed rules.
list_by_zone	select	package_id, zone_id	mode, group_id, page, per_page, order, direction, match, description, priority	Fetches WAF rules in a WAF package. Note: Applies only to the previous version of WAF managed rules.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
package_id	string
rule_id	string	The rule ID.
zone_id	string	The Cloudflare zone ID.
description	string
direction	string
group_id	string
match	string
mode	string
order	string
page	number
per_page	number
priority	string

SELECT examples

get_by_zone

Fetches the details of a WAF rule in a WAF package. Note: Applies only to the previous version of WAF managed rules.

SELECT
errors,
messages,
result,
success
FROM cloudflare.firewall.packages_rules
WHERE rule_id = '{{ rule_id }}' -- required
AND package_id = '{{ package_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;

list_by_zone

Fetches WAF rules in a WAF package. Note: Applies only to the previous version of WAF managed rules.

SELECT
id,
package_id,
allowed_modes,
default_mode,
description,
group,
mode,
priority
FROM cloudflare.firewall.packages_rules
WHERE package_id = '{{ package_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
AND mode = '{{ mode }}'
AND group_id = '{{ group_id }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND order = '{{ order }}'
AND direction = '{{ direction }}'
AND match = '{{ match }}'
AND description = '{{ description }}'
AND priority = '{{ priority }}'
;