api_key_validation
Creates, updates, deletes, gets or lists an api_key_validation resource.
Overview​
| Name | api_key_validation |
| Type | Resource |
| Id | datadog.organization.api_key_validation |
Fields​
The following fields are returned by SELECT queries:
- validate
| Name | Datatype | Description |
|---|---|---|
id | string | The UUID of the organization associated with the API key. (example: 550e8400-e29b-41d4-a716-446655440000) |
attributes | object | Attributes of the API key validation response. |
type | string | Resource type for the API key validation response. (validate_v2) (example: validate_v2) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
validate | select | Check 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.
| 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​
- validate
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
;