ip_allowlist
Creates, updates, deletes, gets or lists an ip_allowlist
resource.
Overview
Name | ip_allowlist |
Type | Resource |
Id | datadog.organization.ip_allowlist |
Fields
The following fields are returned by SELECT
queries:
- get_ipallowlist
Name | Datatype | Description |
---|---|---|
id | string | The unique identifier of the org. |
attributes | object | Attributes of the IP allowlist. |
type | string | IP allowlist type. (default: ip_allowlist, example: ip_allowlist) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_ipallowlist | select | region | Returns the IP allowlist and its enabled or disabled state. | |
update_ipallowlist | update | region , data__data | Edit the entries in the IP allowlist, and enable or disable it. |
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 |
---|---|---|
region | string | (default: datadoghq.com) |
SELECT
examples
- get_ipallowlist
Returns the IP allowlist and its enabled or disabled state.
SELECT
id,
attributes,
type
FROM datadog.organization.ip_allowlist
WHERE region = '{{ region }}' -- required
;
UPDATE
examples
- update_ipallowlist
Edit the entries in the IP allowlist, and enable or disable it.
UPDATE datadog.organization.ip_allowlist
SET
data__data = '{{ data }}'
WHERE
region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data;