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. (ip_allowlist) (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 | Returns the IP allowlist and its enabled or disabled state. | ||
update_ipallowlist | update | 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 |
|---|---|---|
site | string | The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both. |
SELECT examples
- get_ipallowlist
Returns the IP allowlist and its enabled or disabled state.
SELECT
id,
attributes,
type
FROM datadog.organization.ip_allowlist
;
UPDATE examples
- update_ipallowlist
Edit the entries in the IP allowlist, and enable or disable it.
UPDATE datadog.organization.ip_allowlist
SET
data = '{{ data }}'
WHERE
data = '{{ data }}' --required
RETURNING
data;