Action Connection

Action connections extend your installed integrations and allow you to take action in your third-party systems (e.g. AWS, GitLab, and Statuspage) with Datadog’s Workflow Automation and App Builder products.

Datadog’s Integrations automatically provide authentication for Slack, Microsoft Teams, PagerDuty, Opsgenie, JIRA, GitHub, and Statuspage. You do not need additional connections in order to access these tools within Workflow Automation and App Builder.

We offer granular access control for editing and resolving connections.

GET https://api.ap1.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.datadoghq.eu/api/v2/actions/connections/{connection_id}https://api.ddog-gov.com/api/v2/actions/connections/{connection_id}https://api.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.us3.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.us5.datadoghq.com/api/v2/actions/connections/{connection_id}

Overview

Get an existing Action Connection

Arguments

Path Parameters

Name

Type

Description

connection_id [required]

string

The ID of the action connection

Response

Successfully get Action Connection

The response for found connection

Expand All

Field

Type

Description

data

object

Data related to the connection.

attributes [required]

object

The definition of ActionConnectionAttributes object.

integration [required]

 <oneOf>

The definition of ActionConnectionIntegration object.

Option 1

object

The definition of AWSIntegration object.

credentials [required]

 <oneOf>

The definition of AWSCredentials object.

Option 1

object

The definition of AWSAssumeRole object.

account_id [required]

string

AWS account the connection is created for

external_id

string

External ID used to scope which connection can be used to assume the role

principal_id

string

AWS account that will assume the role

role [required]

string

Role to assume

type [required]

enum

The definition of AWSAssumeRoleType object. Allowed enum values: AWSAssumeRole

type [required]

enum

The definition of AWSIntegrationType object. Allowed enum values: AWS

Option 2

object

The definition of HTTPIntegration object.

base_url [required]

string

Base HTTP url for the integration

credentials [required]

 <oneOf>

The definition of HTTPCredentials object.

Option 1

object

The definition of HTTPTokenAuth object.

body

object

The definition of HTTPBody object.

content

string

Serialized body content

content_type

string

Content type of the body

headers

[object]

The HTTPTokenAuth headers.

name [required]

string

The HTTPHeader name.

value [required]

string

The HTTPHeader value.

tokens

[object]

The HTTPTokenAuth tokens.

name [required]

string

The HTTPToken name.

type [required]

enum

The definition of TokenType object. Allowed enum values: SECRET

value [required]

string

The HTTPToken value.

type [required]

enum

The definition of HTTPTokenAuthType object. Allowed enum values: HTTPTokenAuth

url_parameters

[object]

The HTTPTokenAuth url_parameters.

name [required]

string

Name for tokens.

value [required]

string

The UrlParam value.

type [required]

enum

The definition of HTTPIntegrationType object. Allowed enum values: HTTP

name [required]

string

Name of the connection

id

string

The connection identifier

type [required]

enum

The definition of ActionConnectionDataType object. Allowed enum values: action_connection

{
  "data": {
    "attributes": {
      "integration": {
        "credentials": {
          "account_id": "111222333444",
          "external_id": "33a1011635c44b38a064cf14e82e1d8f",
          "principal_id": "123456789012",
          "role": "my-role",
          "type": "AWSAssumeRole"
        },
        "type": "AWS"
      },
      "name": "My AWS Connection"
    },
    "id": "string",
    "type": "action_connection"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too Many Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Code Example

                  # Path parameters
export connection_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions/connections/${connection_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

POST https://api.ap1.datadoghq.com/api/v2/actions/connectionshttps://api.datadoghq.eu/api/v2/actions/connectionshttps://api.ddog-gov.com/api/v2/actions/connectionshttps://api.datadoghq.com/api/v2/actions/connectionshttps://api.us3.datadoghq.com/api/v2/actions/connectionshttps://api.us5.datadoghq.com/api/v2/actions/connections

Overview

Create a new Action Connection

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data related to the connection.

attributes [required]

object

The definition of ActionConnectionAttributes object.

integration [required]

 <oneOf>

The definition of ActionConnectionIntegration object.

Option 1

object

The definition of AWSIntegration object.

credentials [required]

 <oneOf>

The definition of AWSCredentials object.

Option 1

object

The definition of AWSAssumeRole object.

account_id [required]

string

AWS account the connection is created for

external_id

string

External ID used to scope which connection can be used to assume the role

principal_id

string

AWS account that will assume the role

role [required]

string

Role to assume

type [required]

enum

The definition of AWSAssumeRoleType object. Allowed enum values: AWSAssumeRole

type [required]

enum

The definition of AWSIntegrationType object. Allowed enum values: AWS

Option 2

object

The definition of HTTPIntegration object.

base_url [required]

string

Base HTTP url for the integration

credentials [required]

 <oneOf>

The definition of HTTPCredentials object.

Option 1

object

The definition of HTTPTokenAuth object.

body

object

The definition of HTTPBody object.

content

string

Serialized body content

content_type

string

Content type of the body

headers

[object]

The HTTPTokenAuth headers.

name [required]

string

The HTTPHeader name.

value [required]

string

The HTTPHeader value.

tokens

[object]

The HTTPTokenAuth tokens.

name [required]

string

The HTTPToken name.

type [required]

enum

The definition of TokenType object. Allowed enum values: SECRET

value [required]

string

The HTTPToken value.

type [required]

enum

The definition of HTTPTokenAuthType object. Allowed enum values: HTTPTokenAuth

url_parameters

[object]

The HTTPTokenAuth url_parameters.

name [required]

string

Name for tokens.

value [required]

string

The UrlParam value.

type [required]

enum

The definition of HTTPIntegrationType object. Allowed enum values: HTTP

name [required]

string

Name of the connection

id

string

The connection identifier

type [required]

enum

The definition of ActionConnectionDataType object. Allowed enum values: action_connection

{
  "data": {
    "type": "action_connection",
    "attributes": {
      "name": "Cassette Connection DELETE_ME",
      "integration": {
        "type": "AWS",
        "credentials": {
          "type": "AWSAssumeRole",
          "role": "MyRoleUpdated",
          "account_id": "123456789123"
        }
      }
    }
  }
}

Response

Successfully created Action Connection

The response for a created connection

Expand All

Field

Type

Description

data

object

Data related to the connection.

attributes [required]

object

The definition of ActionConnectionAttributes object.

integration [required]

 <oneOf>

The definition of ActionConnectionIntegration object.

Option 1

object

The definition of AWSIntegration object.

credentials [required]

 <oneOf>

The definition of AWSCredentials object.

Option 1

object

The definition of AWSAssumeRole object.

account_id [required]

string

AWS account the connection is created for

external_id

string

External ID used to scope which connection can be used to assume the role

principal_id

string

AWS account that will assume the role

role [required]

string

Role to assume

type [required]

enum

The definition of AWSAssumeRoleType object. Allowed enum values: AWSAssumeRole

type [required]

enum

The definition of AWSIntegrationType object. Allowed enum values: AWS

Option 2

object

The definition of HTTPIntegration object.

base_url [required]

string

Base HTTP url for the integration

credentials [required]

 <oneOf>

The definition of HTTPCredentials object.

Option 1

object

The definition of HTTPTokenAuth object.

body

object

The definition of HTTPBody object.

content

string

Serialized body content

content_type

string

Content type of the body

headers

[object]

The HTTPTokenAuth headers.

name [required]

string

The HTTPHeader name.

value [required]

string

The HTTPHeader value.

tokens

[object]

The HTTPTokenAuth tokens.

name [required]

string

The HTTPToken name.

type [required]

enum

The definition of TokenType object. Allowed enum values: SECRET

value [required]

string

The HTTPToken value.

type [required]

enum

The definition of HTTPTokenAuthType object. Allowed enum values: HTTPTokenAuth

url_parameters

[object]

The HTTPTokenAuth url_parameters.

name [required]

string

Name for tokens.

value [required]

string

The UrlParam value.

type [required]

enum

The definition of HTTPIntegrationType object. Allowed enum values: HTTP

name [required]

string

Name of the connection

id

string

The connection identifier

type [required]

enum

The definition of ActionConnectionDataType object. Allowed enum values: action_connection

{
  "data": {
    "attributes": {
      "integration": {
        "credentials": {
          "account_id": "111222333444",
          "external_id": "33a1011635c44b38a064cf14e82e1d8f",
          "principal_id": "123456789012",
          "role": "my-role",
          "type": "AWSAssumeRole"
        },
        "type": "AWS"
      },
      "name": "My AWS Connection"
    },
    "id": "string",
    "type": "action_connection"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too Many Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Code Example

                          # Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions/connections" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "type": "action_connection", "attributes": { "name": "Cassette Connection DELETE_ME", "integration": { "type": "AWS", "credentials": { "type": "AWSAssumeRole", "role": "MyRoleUpdated", "account_id": "123456789123" } } } } } EOF

PATCH https://api.ap1.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.datadoghq.eu/api/v2/actions/connections/{connection_id}https://api.ddog-gov.com/api/v2/actions/connections/{connection_id}https://api.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.us3.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.us5.datadoghq.com/api/v2/actions/connections/{connection_id}

Overview

Update an existing Action Connection

Arguments

Path Parameters

Name

Type

Description

connection_id [required]

string

The ID of the action connection

Request

Body Data (required)

Update an existing Action Connection request body

Expand All

Field

Type

Description

data [required]

object

Data related to the connection update.

attributes [required]

object

The definition of ActionConnectionAttributesUpdate object.

integration

 <oneOf>

The definition of ActionConnectionIntegrationUpdate object.

Option 1

object

The definition of AWSIntegrationUpdate object.

credentials

 <oneOf>

The definition of AWSCredentialsUpdate object.

Option 1

object

The definition of AWSAssumeRoleUpdate object.

account_id

string

AWS account the connection is created for

generate_new_external_id

boolean

The AWSAssumeRoleUpdate generate_new_external_id.

role

string

Role to assume

type [required]

enum

The definition of AWSAssumeRoleType object. Allowed enum values: AWSAssumeRole

type [required]

enum

The definition of AWSIntegrationType object. Allowed enum values: AWS

Option 2

object

The definition of HTTPIntegrationUpdate object.

base_url

string

Base HTTP url for the integration

credentials

 <oneOf>

The definition of HTTPCredentialsUpdate object.

Option 1

object

The definition of HTTPTokenAuthUpdate object.

body

object

The definition of HTTPBody object.

content

string

Serialized body content

content_type

string

Content type of the body

headers

[object]

The HTTPTokenAuthUpdate headers.

deleted

boolean

Should the header be deleted.

name [required]

string

The HTTPHeaderUpdate name.

value

string

The HTTPHeaderUpdate value.

tokens

[object]

The HTTPTokenAuthUpdate tokens.

deleted

boolean

Should the header be deleted.

name [required]

string

The HTTPToken name.

type [required]

enum

The definition of TokenType object. Allowed enum values: SECRET

value [required]

string

The HTTPToken value.

type [required]

enum

The definition of HTTPTokenAuthType object. Allowed enum values: HTTPTokenAuth

url_parameters

[object]

The HTTPTokenAuthUpdate url_parameters.

deleted

boolean

Should the header be deleted.

name [required]

string

Name for tokens.

value

string

The UrlParamUpdate value.

type [required]

enum

The definition of HTTPIntegrationType object. Allowed enum values: HTTP

name

string

Name of the connection

type [required]

enum

The definition of ActionConnectionDataType object. Allowed enum values: action_connection

{
  "data": {
    "type": "action_connection",
    "attributes": {
      "name": "Cassette Connection",
      "integration": {
        "type": "AWS",
        "credentials": {
          "type": "AWSAssumeRole",
          "role": "MyRoleUpdated",
          "account_id": "123456789123"
        }
      }
    }
  }
}

Response

Successfully updated Action Connection

The response for an updated connection.

Expand All

Field

Type

Description

data

object

Data related to the connection.

attributes [required]

object

The definition of ActionConnectionAttributes object.

integration [required]

 <oneOf>

The definition of ActionConnectionIntegration object.

Option 1

object

The definition of AWSIntegration object.

credentials [required]

 <oneOf>

The definition of AWSCredentials object.

Option 1

object

The definition of AWSAssumeRole object.

account_id [required]

string

AWS account the connection is created for

external_id

string

External ID used to scope which connection can be used to assume the role

principal_id

string

AWS account that will assume the role

role [required]

string

Role to assume

type [required]

enum

The definition of AWSAssumeRoleType object. Allowed enum values: AWSAssumeRole

type [required]

enum

The definition of AWSIntegrationType object. Allowed enum values: AWS

Option 2

object

The definition of HTTPIntegration object.

base_url [required]

string

Base HTTP url for the integration

credentials [required]

 <oneOf>

The definition of HTTPCredentials object.

Option 1

object

The definition of HTTPTokenAuth object.

body

object

The definition of HTTPBody object.

content

string

Serialized body content

content_type

string

Content type of the body

headers

[object]

The HTTPTokenAuth headers.

name [required]

string

The HTTPHeader name.

value [required]

string

The HTTPHeader value.

tokens

[object]

The HTTPTokenAuth tokens.

name [required]

string

The HTTPToken name.

type [required]

enum

The definition of TokenType object. Allowed enum values: SECRET

value [required]

string

The HTTPToken value.

type [required]

enum

The definition of HTTPTokenAuthType object. Allowed enum values: HTTPTokenAuth

url_parameters

[object]

The HTTPTokenAuth url_parameters.

name [required]

string

Name for tokens.

value [required]

string

The UrlParam value.

type [required]

enum

The definition of HTTPIntegrationType object. Allowed enum values: HTTP

name [required]

string

Name of the connection

id

string

The connection identifier

type [required]

enum

The definition of ActionConnectionDataType object. Allowed enum values: action_connection

{
  "data": {
    "attributes": {
      "integration": {
        "credentials": {
          "account_id": "111222333444",
          "external_id": "33a1011635c44b38a064cf14e82e1d8f",
          "principal_id": "123456789012",
          "role": "my-role",
          "type": "AWSAssumeRole"
        },
        "type": "AWS"
      },
      "name": "My AWS Connection"
    },
    "id": "string",
    "type": "action_connection"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too Many Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Code Example

                          # Path parameters
export connection_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions/connections/${connection_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "type": "action_connection", "attributes": { "name": "Cassette Connection", "integration": { "type": "AWS", "credentials": { "type": "AWSAssumeRole", "role": "MyRoleUpdated", "account_id": "123456789123" } } } } } EOF

DELETE https://api.ap1.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.datadoghq.eu/api/v2/actions/connections/{connection_id}https://api.ddog-gov.com/api/v2/actions/connections/{connection_id}https://api.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.us3.datadoghq.com/api/v2/actions/connections/{connection_id}https://api.us5.datadoghq.com/api/v2/actions/connections/{connection_id}

Overview

Delete an existing Action Connection This endpoint requires the connection_write permission.

Arguments

Path Parameters

Name

Type

Description

connection_id [required]

string

The ID of the action connection

Response

The resource was deleted successfully.

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too Many Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Code Example

                  # Path parameters
export connection_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions/connections/${connection_id}" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"