Skip to main content

ip_allowlist

Creates, updates, deletes, gets or lists an ip_allowlist resource.

Overview

Nameip_allowlist
TypeResource
Iddatadog.organization.ip_allowlist

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe unique identifier of the org.
attributesobjectAttributes of the IP allowlist.
typestringIP allowlist type. (ip_allowlist) (default: ip_allowlist, example: ip_allowlist)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_ipallowlistselectReturns the IP allowlist and its enabled or disabled state.
update_ipallowlistupdatedataEdit 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.

NameDatatypeDescription
sitestringThe 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

Returns the IP allowlist and its enabled or disabled state.

SELECT
id,
attributes,
type
FROM datadog.organization.ip_allowlist
;

UPDATE examples

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;