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. (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 , region | Get an existing Action Connection. This API requires a registered application key. | |
create_action_connection | insert | region , data__data | Create a new Action Connection. This API requires a registered application key. | |
update_action_connection | update | connection_id , region , data__data | Update an existing Action Connection. This API requires a registered application key. | |
delete_action_connection | delete | connection_id , region | Delete 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.
Name | Datatype | Description |
---|---|---|
connection_id | string | The ID of the action connection |
region | string | (default: datadoghq.com) |
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
AND region = '{{ region }}' -- required
;
INSERT
examples
- create_action_connection
- Manifest
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
;
# Description fields are for documentation purposes
- name: connections
props:
- name: region
value: string
description: Required parameter for the connections resource.
- name: data
value: object
description: |
Data related to the connection.
UPDATE
examples
- update_action_connection
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_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
AND region = '{{ region }}' --required
;