key_validation
Creates, updates, deletes, gets or lists a key_validation resource.
Overview​
| Name | key_validation |
| Type | Resource |
| Id | datadog.organization.key_validation |
Fields​
The following fields are returned by SELECT queries:
- validate_apikey
| Name | Datatype | Description |
|---|---|---|
status | string | Status of the validation. Always ok when both the API key and the application key are valid. (ok) (example: ok) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
validate_apikey | select | Check that the API key and application key used for the request are both valid.<br />Returns {"status": "ok"} on success, 401 or 403 otherwise. Useful as a<br />lightweight authentication probe before issuing other API calls that require<br />full credentials. |
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_apikey
Check that the API key and application key used for the request are both valid.<br />Returns {"status": "ok"} on success, 401 or 403 otherwise. Useful as a<br />lightweight authentication probe before issuing other API calls that require<br />full credentials.
SELECT
status
FROM datadog.organization.key_validation
;