application_keys

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

Overview

Name	application_keys
Type	Resource
Id	datadog.organization.application_keys

Fields

The following fields are returned by SELECT queries:

get_application_key

Name	Datatype	Description
id	string	ID of the application key.
attributes	object	Attributes of a full application key.
relationships	object	Resources related to the application key.
type	string	Application Keys resource type. (application_keys) (default: application_keys, example: application_keys)

list_application_keys

Name	Datatype	Description
id	string	ID of the application key.
attributes	object	Attributes of a partial application key.
relationships	object	Resources related to the application key.
type	string	Application Keys resource type. (application_keys) (default: application_keys, example: application_keys)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application_key	select	app_key_id	include	Get an application key for your org.
list_application_keys	select		page[size], page[number], sort, filter, filter[created_at][start], filter[created_at][end], filter[owned_by], include	List all application keys available for your org
create_application_key_v1	insert			Create an application key with a given name.<br />This endpoint is disabled for organizations in [One-Time Read mode](https:​//docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).<br /><br />Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https:​//docs.datadoghq.com/api/latest/key-management/) endpoints instead.
update_application_key	update	app_key_id, data		Edit an application key
delete_application_key	delete	app_key_id		Delete an application 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 application key.
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.
filter	string	Filter application keys by the specified string.
filter[created_at][end]	string	Only include application keys created on or before the specified date.
filter[created_at][start]	string	Only include application keys created on or after the specified date.
filter[owned_by]	string	Filter application keys by owner ID.
include	string	Resource path for related resources to include in the response. Only owned_by is supported.
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Number of items to return per page. The maximum allowed value is 100.
sort	string	Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.

SELECT examples

get_application_key

Get an application key for your org.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.application_keys
WHERE app_key_id = '{{ app_key_id }}' -- required
AND include = '{{ include }}'
;

list_application_keys

List all application keys available for your org

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.application_keys
WHERE page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND sort = '{{ sort }}'
AND filter = '{{ filter }}'
AND filter[created_at][start] = '{{ filter[created_at][start] }}'
AND filter[created_at][end] = '{{ filter[created_at][end] }}'
AND filter[owned_by] = '{{ filter[owned_by] }}'
AND include = '{{ include }}'
;

INSERT examples

create_application_key_v1

Create an application key with a given name.<br />This endpoint is disabled for organizations in [One-Time Read mode](https:​//docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).<br /><br />Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https:​//docs.datadoghq.com/api/latest/key-management/) endpoints instead.

INSERT INTO datadog.organization.application_keys (
name
)
SELECT 
'{{ name }}'
RETURNING
application_key
;

Manifest

# Description fields are for documentation purposes
- name: application_keys
props:
  - name: name
    value: "{{ name }}"
    description: |
      Name of an application key.

UPDATE examples

update_application_key

Edit an application key

UPDATE datadog.organization.application_keys
SET 
data = '{{ data }}'
WHERE 
app_key_id = '{{ app_key_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data,
included;

DELETE examples

delete_application_key

Delete an application key

DELETE FROM datadog.organization.application_keys
WHERE app_key_id = '{{ app_key_id }}' --required
;