Skip to main content

app_key_registrations

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

Overview

Nameapp_key_registrations
TypeResource
Iddatadog.actions.app_key_registrations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uuid)The app key registration identifier
typestringThe definition of AppKeyRegistrationDataType object. (example: app_key_registration)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_app_key_registrationselectapp_key_id, regionGet an existing App Key Registration
list_app_key_registrationsselectregionpage[size], page[number]List App Key Registrations
unregister_app_keyexecapp_key_id, regionUnregister an App Key
register_app_keyexecapp_key_id, regionRegister 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.

NameDatatypeDescription
app_key_idstringThe ID of the app key
regionstring(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 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
;

Lifecycle Methods

Unregister an App Key

EXEC datadog.actions.app_key_registrations.unregister_app_key 
@app_key_id='{{ app_key_id }}' --required,
@region='{{ region }}' --required
;