Skip to main content

connections

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

Overview

Nameconnections
TypeResource
Iddatadog.actions.connections

Fields

The following fields are returned by SELECT queries:

Successfully get Action Connection

NameDatatypeDescription
idstringThe connection identifier
attributesobjectThe definition of ActionConnectionAttributes object.
typestringThe definition of ActionConnectionDataType object. (example: action_connection)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_action_connectionselectconnection_id, regionGet an existing Action Connection. This API requires a registered application key.
create_action_connectioninsertregion, data__dataCreate a new Action Connection. This API requires a registered application key.
update_action_connectionupdateconnection_id, region, data__dataUpdate an existing Action Connection. This API requires a registered application key.
delete_action_connectiondeleteconnection_id, regionDelete an existing Action Connection. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

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
connection_idstringThe ID of the action connection
regionstring(default: datadoghq.com)

SELECT examples

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
AND region = '{{ region }}' -- required
;

INSERT examples

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

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

UPDATE examples

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

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

DELETE examples

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
AND region = '{{ region }}' --required
;