app_key_registrations
Creates, updates, deletes, gets or lists an app_key_registrations
resource.
Overview
Name | app_key_registrations |
Type | Resource |
Id | datadog.actions.app_key_registrations |
Fields
The following fields are returned by SELECT
queries:
- get_app_key_registration
- list_app_key_registrations
Name | Datatype | Description |
---|---|---|
id | string (uuid) | The app key registration identifier |
type | string | The definition of AppKeyRegistrationDataType object. (example: app_key_registration) |
Name | Datatype | Description |
---|---|---|
id | string (uuid) | The app key registration identifier |
type | string | The definition of AppKeyRegistrationDataType object. (example: app_key_registration) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_app_key_registration | select | app_key_id , region | Get an existing App Key Registration | |
list_app_key_registrations | select | region | page[size] , page[number] | List App Key Registrations |
unregister_app_key | exec | app_key_id , region | Unregister an App Key | |
register_app_key | exec | app_key_id , region | Register a new App Key |
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 |
---|---|---|
app_key_id | string | The ID of the app key |
region | string | (default: datadoghq.com) |
page[number] | integer (int64) | The page number to return. |
page[size] | integer (int64) | The number of App Key Registrations to return per page. |
SELECT
examples
- get_app_key_registration
- list_app_key_registrations
Get an existing App Key Registration
SELECT
id,
type
FROM datadog.actions.app_key_registrations
WHERE app_key_id = '{{ app_key_id }}' -- required
AND region = '{{ region }}' -- required
;
List App Key Registrations
SELECT
id,
type
FROM datadog.actions.app_key_registrations
WHERE region = '{{ region }}' -- required
AND page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
;
Lifecycle Methods
- unregister_app_key
- register_app_key
Unregister an App Key
EXEC datadog.actions.app_key_registrations.unregister_app_key
@app_key_id='{{ app_key_id }}' --required,
@region='{{ region }}' --required
;
Register a new App Key
EXEC datadog.actions.app_key_registrations.register_app_key
@app_key_id='{{ app_key_id }}' --required,
@region='{{ region }}' --required
;