entity_integration_configs

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

Overview

Name	entity_integration_configs
Type	Resource
Id	datadog.integrations.entity_integration_configs

Fields

The following fields are returned by SELECT queries:

get_entity_integration_config

Name	Datatype	Description
id	string	Unique identifier of the entity integration configuration. (example: 01HJABCD12345678ABCDEFGHIJ)
attributes	object	The organization ID, integration identifier, and integration-specific configuration payload for an entity integration configuration.
type	string	JSON:API resource type for an entity integration configuration. Always entity_integration_configs. (entity_integration_configs) (default: entity_integration_configs, example: entity_integration_configs)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_entity_integration_config	select	integration_id		Retrieve the configuration currently stored for a given integration in the caller's organization.
update_entity_integration_config	replace	integration_id, data		Create or replace the configuration for a given integration in the caller's organization. The shape of data.attributes.config depends on the integration:<br /><br />- For github: config must contain an enabled_repos array of objects with hostname, github_org_name, and repo_name.<br />- For jira: config must contain an enabled_projects array of objects with hostname, account_id, and project_key.<br />- For pagerduty: config must contain an accounts array of objects with a required enabled boolean and an optional subdomain string.
delete_entity_integration_config	delete	integration_id		Delete the configuration stored for a given integration in the caller's organization.

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
integration_id	string	The identifier of the integration whose configuration is being managed. Supported values are github, jira, and pagerduty.
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

get_entity_integration_config

Retrieve the configuration currently stored for a given integration in the caller's organization.

SELECT
id,
attributes,
type
FROM datadog.integrations.entity_integration_configs
WHERE integration_id = '{{ integration_id }}' -- required
;

REPLACE examples

update_entity_integration_config

Create or replace the configuration for a given integration in the caller's organization. The shape of data.attributes.config depends on the integration:<br /><br />- For github: config must contain an enabled_repos array of objects with hostname, github_org_name, and repo_name.<br />- For jira: config must contain an enabled_projects array of objects with hostname, account_id, and project_key.<br />- For pagerduty: config must contain an accounts array of objects with a required enabled boolean and an optional subdomain string.

REPLACE datadog.integrations.entity_integration_configs
SET 
data = '{{ data }}'
WHERE 
integration_id = '{{ integration_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_entity_integration_config

Delete the configuration stored for a given integration in the caller's organization.

DELETE FROM datadog.integrations.entity_integration_configs
WHERE integration_id = '{{ integration_id }}' --required
;