List incident rules - Incidents

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GEThttps://api.datadoghq.com/api/v2/incidents/config/ruleshttps://api.us3.datadoghq.com/api/v2/incidents/config/ruleshttps://api.us5.datadoghq.com/api/v2/incidents/config/ruleshttps://api.datadoghq.eu/api/v2/incidents/config/ruleshttps://api.ap1.datadoghq.com/api/v2/incidents/config/ruleshttps://api.ap2.datadoghq.com/api/v2/incidents/config/ruleshttps://api.uk1.datadoghq.com/api/v2/incidents/config/ruleshttps://api.ddog-gov.com/api/v2/incidents/config/ruleshttps://api.us2.ddog-gov.com/api/v2/incidents/config/rules

Présentation

List all incident rules.

This endpoint requires any of the following permissions:

incident_settings_read
incident_notification_settings_read

OAuth apps require the incident_settings_read authorization scope to access this endpoint.

Arguments

Chaînes de requête

Name

Type

Description

filter[task_id]

string

Filter rules by task ID.

filter[trigger]

string

Filter rules by trigger.

incidentTypeUUID

string

Filter rules by incident type UUID.

Réponse

Response with a list of incident rules.

Champ

Type

Description

data [required]

[object]

List of incident rules.

{
  "data": [
    {
      "attributes": {
        "condition": {
          "normalized_query": "severity:SEV-1",
          "raw_query": "severity:SEV-1"
        },
        "condition_table_type": 1,
        "conditions": [
          {
            "field": "severity",
            "values": [
              "SEV-1",
              "SEV-2"
            ]
          }
        ],
        "created": "2024-01-01T00:00:00.000Z",
        "created_by_uuid": "00000000-0000-0000-0000-000000000001",
        "deleted": null,
        "enabled": true,
        "execution_type": 1,
        "incident_settings_association_uuid": null,
        "match_any_condition": false,
        "modified": "2024-01-01T00:00:00.000Z",
        "modified_by_uuid": "00000000-0000-0000-0000-000000000001",
        "org_id": 123456,
        "task_id": "notify-incident-handles-job",
        "task_payload": "{}",
        "trigger": "incident_created_trigger"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "incidents_rules"
    }
  ]
}

Bad Request

API error response.

Champ

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Champ

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Champ

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Champ

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Exemple de code

List incident rules

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/incidents/config/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"