connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	datadog.actions.connections

Fields

The following fields are returned by SELECT queries:

get_action_connection

Successfully get Action Connection

Name	Datatype	Description
id	string	The connection identifier
attributes	object	The definition of ActionConnectionAttributes object.
type	string	The definition of ActionConnectionDataType object. (action_connection) (example: action_connection)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_action_connection	select	connection_id		Get an existing Action Connection. This API requires a [registered application key](https:​//docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
create_action_connection	insert	data		Create a new Action Connection. This API requires a [registered application key](https:​//docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
update_action_connection	update	connection_id, data		Update an existing Action Connection. This API requires a [registered application key](https:​//docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
delete_action_connection	delete	connection_id		Delete an existing Action Connection. This API requires a [registered application key](https:​//docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https:​//docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

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
connection_id	string	The ID of the action connection
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_action_connection

Get an existing Action Connection. This API requires a registered application key.

SELECT
id,
attributes,
type
FROM datadog.actions.connections
WHERE connection_id = '{{ connection_id }}' -- required
;

INSERT examples

create_action_connection

Create a new Action Connection. This API requires a registered application key.

INSERT INTO datadog.actions.connections (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: connections
props:
  - name: data
    description: |
      Data related to the connection.
    value:
      attributes:
        integration:
          credentials:
            account_id: "{{ account_id }}"
            external_id: "{{ external_id }}"
            principal_id: "{{ principal_id }}"
            role: "{{ role }}"
            type: "{{ type }}"
          type: "{{ type }}"
          base_url: "{{ base_url }}"
        name: "{{ name }}"
        tags:
          - "{{ tags }}"
      id: "{{ id }}"
      type: "{{ type }}"

UPDATE examples

update_action_connection

Update an existing Action Connection. This API requires a registered application key.

UPDATE datadog.actions.connections
SET 
data = '{{ data }}'
WHERE 
connection_id = '{{ connection_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_action_connection

Delete an existing Action Connection. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

DELETE FROM datadog.actions.connections
WHERE connection_id = '{{ connection_id }}' --required
;