queries
Creates, updates, deletes, gets or lists a queries resource.
Overview
| Name | queries |
| Type | Resource |
| Id | cloudflare.brand_protection.queries |
Fields
The following fields are returned by SELECT queries:
- list
Successfully retrieved queries
| Name | Datatype | Description |
|---|---|---|
query_id | integer | |
created | string | |
parameters | object | |
query_tag | string | |
scan | boolean | |
updated | string |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | account_id | id | Get all saved brand protection queries for an account |
delete | delete | account_id | id, tag, scan | Return a success message after deleting saved string queries by ID |
bulk | exec | account_id | Return a success message after creating new saved string queries in bulk |
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 |
|---|---|---|
account_id | string | The Cloudflare account ID. |
id | string | |
scan | boolean | |
tag | string |
SELECT examples
- list
Get all saved brand protection queries for an account
SELECT
query_id,
created,
parameters,
query_tag,
scan,
updated
FROM cloudflare.brand_protection.queries
WHERE account_id = '{{ account_id }}' -- required
AND id = '{{ id }}'
;
DELETE examples
- delete
Return a success message after deleting saved string queries by ID
DELETE FROM cloudflare.brand_protection.queries
WHERE account_id = '{{ account_id }}' --required
AND id = '{{ id }}'
AND tag = '{{ tag }}'
AND scan = '{{ scan }}'
;
Lifecycle Methods
- bulk
Return a success message after creating new saved string queries in bulk
EXEC cloudflare.brand_protection.queries.bulk
@account_id='{{ account_id }}' --required
@@json=
'{
"queries": "{{ queries }}"
}'
;