packages
Creates, updates, deletes, gets or lists a packages resource.
Overview
| Name | packages |
| Type | Resource |
| Id | cloudflare.firewall.packages |
Fields
The following fields are returned by SELECT queries:
- get
- list
Get a WAF package response
| Name | Datatype | Description |
|---|---|---|
errors | array | |
messages | array | |
result | object | |
success | boolean | Defines whether the API call was successful. (true) |
List WAF packages response
| Name | Datatype | Description |
|---|
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | package_id, zone_id | Fetches the details of a WAF package. Note: Applies only to the previous version of WAF managed rules. | |
list | select | zone_id | page, per_page, order, direction, match, name | Fetches WAF packages for a zone. Note: Applies only to the previous version of WAF managed rules. |
waf_packages_update_a_waf_package | update | package_id, zone_id | Updates a WAF package. You can update the sensitivity and the action of an anomaly detection 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 | |
zone_id | string | The Cloudflare zone ID. |
direction | string | |
match | string | |
name | string | |
order | string | |
page | number | |
per_page | number |
SELECT examples
- get
- list
Fetches the details of a WAF package. Note: Applies only to the previous version of WAF managed rules.
SELECT
errors,
messages,
result,
success
FROM cloudflare.firewall.packages
WHERE package_id = '{{ package_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;
Fetches WAF packages for a zone. Note: Applies only to the previous version of WAF managed rules.
SELECT
*
FROM cloudflare.firewall.packages
WHERE zone_id = '{{ zone_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND order = '{{ order }}'
AND direction = '{{ direction }}'
AND match = '{{ match }}'
AND name = '{{ name }}'
;
UPDATE examples
- waf_packages_update_a_waf_package
Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package. Note: Applies only to the previous version of WAF managed rules.
UPDATE cloudflare.firewall.packages
SET
action_mode = '{{ action_mode }}',
sensitivity = '{{ sensitivity }}'
WHERE
package_id = '{{ package_id }}' --required
AND zone_id = '{{ zone_id }}' --required
RETURNING
errors,
messages,
result,
success;