Skip to main content

api_key_validation

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

Overview

Nameapi_key_validation
TypeResource
Iddatadog.organization.api_key_validation

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe UUID of the organization associated with the API key. (example: 550e8400-e29b-41d4-a716-446655440000)
attributesobjectAttributes of the API key validation response.
typestringResource type for the API key validation response. (validate_v2) (example: validate_v2)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
validateselectCheck if the API key is valid. Returns the organization UUID, API key ID, and associated scopes.

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

Check if the API key is valid. Returns the organization UUID, API key ID, and associated scopes.

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