incident_integrations

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

Overview

Name	incident_integrations
Type	Resource
Id	datadog.service_management.incident_integrations

Fields

The following fields are returned by SELECT queries:

get_incident_integration

Name	Datatype	Description
id	string	The incident integration metadata's ID. (example: 00000000-0000-0000-1234-000000000000)
attributes	object	Incident integration metadata's attributes for a create request.
relationships	object	The incident's integration relationships from a response.
type	string	Integration metadata resource type. (incident_integrations) (default: incident_integrations, example: incident_integrations)

list_incident_integrations

Name	Datatype	Description
id	string	The incident integration metadata's ID. (example: 00000000-0000-0000-1234-000000000000)
attributes	object	Incident integration metadata's attributes for a create request.
relationships	object	The incident's integration relationships from a response.
type	string	Integration metadata resource type. (incident_integrations) (default: incident_integrations, example: incident_integrations)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_incident_integration	select	incident_id, integration_metadata_id		Get incident integration metadata details.
list_incident_integrations	select	incident_id		Get all integration metadata for an incident.
create_incident_integration	insert	incident_id, data		Create an incident integration metadata.
update_incident_integration	update	incident_id, integration_metadata_id, data		Update an existing incident integration metadata.
delete_incident_integration	delete	incident_id, integration_metadata_id		Delete an incident integration metadata.

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
incident_id	string	The UUID of the incident.
integration_metadata_id	string	The UUID of the incident integration metadata.
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_incident_integration

Get incident integration metadata details.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_integrations
WHERE incident_id = '{{ incident_id }}' -- required
AND integration_metadata_id = '{{ integration_metadata_id }}' -- required
;

list_incident_integrations

Get all integration metadata for an incident.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_integrations
WHERE incident_id = '{{ incident_id }}' -- required
;

INSERT examples

create_incident_integration

Create an incident integration metadata.

INSERT INTO datadog.service_management.incident_integrations (
data,
incident_id
)
SELECT 
'{{ data }}' /* required */,
'{{ incident_id }}'
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: incident_integrations
props:
  - name: incident_id
    value: "{{ incident_id }}"
    description: Required parameter for the incident_integrations resource.
  - name: data
    description: |
      Incident integration metadata data for a create request.
    value:
      attributes:
        created: "{{ created }}"
        incident_id: "{{ incident_id }}"
        integration_type: {{ integration_type }}
        metadata:
          channels:
            - channel_id: "{{ channel_id }}"
              channel_name: "{{ channel_name }}"
              redirect_url: "{{ redirect_url }}"
              team_id: "{{ team_id }}"
          issues:
            - account: "{{ account }}"
              issue_key: "{{ issue_key }}"
              issuetype_id: "{{ issuetype_id }}"
              project_key: "{{ project_key }}"
              redirect_url: "{{ redirect_url }}"
          teams:
            - ms_channel_id: "{{ ms_channel_id }}"
              ms_channel_name: "{{ ms_channel_name }}"
              ms_tenant_id: "{{ ms_tenant_id }}"
              redirect_url: "{{ redirect_url }}"
        modified: "{{ modified }}"
        status: {{ status }}
      type: "{{ type }}"

UPDATE examples

update_incident_integration

Update an existing incident integration metadata.

UPDATE datadog.service_management.incident_integrations
SET 
data = '{{ data }}'
WHERE 
incident_id = '{{ incident_id }}' --required
AND integration_metadata_id = '{{ integration_metadata_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data,
included;

DELETE examples

delete_incident_integration

Delete an incident integration metadata.

DELETE FROM datadog.service_management.incident_integrations
WHERE incident_id = '{{ incident_id }}' --required
AND integration_metadata_id = '{{ integration_metadata_id }}' --required
;