configs_allowlist
Creates, updates, deletes, gets or lists a configs_allowlist resource.
Overview
| Name | configs_allowlist |
| Type | Resource |
| Id | cloudflare.ddos_protection.configs_allowlist |
Fields
The following fields are returned by SELECT queries:
- get
Get allowlist prefix response.
| Name | Datatype | Description |
|---|---|---|
id | string | The unique ID of the allowlist prefix. |
comment | string | An optional comment describing the allowlist prefix. |
created_on | string (date-time) | The creation timestamp of the allowlist prefix. |
enabled | boolean | Whether to enable the allowlist prefix into effect. Defaults to false. |
modified_on | string (date-time) | The last modification timestamp of the allowlist prefix. |
prefix | string | The allowlist prefix in CIDR format. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | account_id, prefix_id | Get an allowlist prefix specified by the given UUID. | |
edit | update | account_id, prefix_id | Update an allowlist prefix specified by the given UUID. | |
delete | delete | account_id, prefix_id | Delete the allowlist prefix for an account given a UUID. |
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. |
prefix_id | string | The IP prefix ID. |
SELECT examples
- get
Get an allowlist prefix specified by the given UUID.
SELECT
id,
comment,
created_on,
enabled,
modified_on,
prefix
FROM cloudflare.ddos_protection.configs_allowlist
WHERE account_id = '{{ account_id }}' -- required
AND prefix_id = '{{ prefix_id }}' -- required
;
UPDATE examples
- edit
Update an allowlist prefix specified by the given UUID.
UPDATE cloudflare.ddos_protection.configs_allowlist
SET
comment = '{{ comment }}',
enabled = {{ enabled }}
WHERE
account_id = '{{ account_id }}' --required
AND prefix_id = '{{ prefix_id }}' --required
RETURNING
errors,
messages,
result,
success;
DELETE examples
- delete
Delete the allowlist prefix for an account given a UUID.
DELETE FROM cloudflare.ddos_protection.configs_allowlist
WHERE account_id = '{{ account_id }}' --required
AND prefix_id = '{{ prefix_id }}' --required
;