payloads
Creates, updates, deletes, gets or lists a payloads resource.
Overview
| Name | payloads |
| Type | Resource |
| Id | cloudflare.content_scanning.payloads |
Fields
The following fields are returned by SELECT queries:
- list
List existing Content Scan custom scan expressions response.
| Name | Datatype | Description |
|---|---|---|
id | string | defines the unique ID for this custom scan expression. (example: a350a054caa840c9becd89c3b4f0195b) |
payload | string | Defines the ruleset expression to use in matching content objects. (example: lookup_json_string(http.request.body.raw, "file")) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | zone_id | Get a list of existing custom scan expressions for Content Scanning. | |
waf_content_scanning_add_custom_scan_expressions | insert | zone_id | Add custom scan expressions for Content Scanning. | |
waf_content_scanning_delete_custom_scan_expressions | delete | zone_id, expression_id | Delete a Content Scan Custom Expression. |
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 |
|---|---|---|
expression_id | string | |
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- list
Get a list of existing custom scan expressions for Content Scanning.
SELECT
id,
payload
FROM cloudflare.content_scanning.payloads
WHERE zone_id = '{{ zone_id }}' -- required
;
INSERT examples
- waf_content_scanning_add_custom_scan_expressions
- Manifest
Add custom scan expressions for Content Scanning.
INSERT INTO cloudflare.content_scanning.payloads (
zone_id
)
SELECT
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;
# Description fields are for documentation purposes
- name: payloads
props:
- name: zone_id
value: "{{ zone_id }}"
description: Required parameter for the payloads resource.
DELETE examples
- waf_content_scanning_delete_custom_scan_expressions
Delete a Content Scan Custom Expression.
DELETE FROM cloudflare.content_scanning.payloads
WHERE zone_id = '{{ zone_id }}' --required
AND expression_id = '{{ expression_id }}' --required
;