인시던트 규칙 업데이트 - Incidents

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

PATCHhttps://api.datadoghq.com/api/v2/incidents/config/rules/{rule_id}https://api.us3.datadoghq.com/api/v2/incidents/config/rules/{rule_id}https://api.us5.datadoghq.com/api/v2/incidents/config/rules/{rule_id}https://api.datadoghq.eu/api/v2/incidents/config/rules/{rule_id}https://api.ap1.datadoghq.com/api/v2/incidents/config/rules/{rule_id}https://api.ap2.datadoghq.com/api/v2/incidents/config/rules/{rule_id}https://api.uk1.datadoghq.com/api/v2/incidents/config/rules/{rule_id}https://api.ddog-gov.com/api/v2/incidents/config/rules/{rule_id}https://api.us2.ddog-gov.com/api/v2/incidents/config/rules/{rule_id}

개요

인시던트 규칙을 업데이트합니다.

This endpoint requires any of the following permissions:

incident_settings_write
incident_notification_settings_write

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

인수

경로 파라미터

이름

유형

설명

rule_id [required]

string

The UUID of the incident rule.

요청

Body Data (required)

인시던트 규칙 패치 페이로드입니다.

항목

유형

설명

data [required]

object

인시던트 규칙 패치를 위한 요청 페이로드입니다.

{
  "data": {
    "attributes": {
      "condition": {
        "normalized_query": "severity:SEV-1",
        "raw_query": "severity:SEV-1"
      },
      "conditions": [
        {
          "field": "severity",
          "values": [
            "SEV-1",
            "SEV-2"
          ]
        }
      ],
      "enabled": true,
      "task_payload": "{}",
      "trigger": "incident_created_trigger"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "incident_rules"
  }
}

응답

Response with a single incident rule.

항목

유형

설명

data [required]

object

Incident rule data in a response.

{
  "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.

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Unauthorized

API error response.

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Forbidden

API error response.

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 예시

인시던트 규칙 업데이트

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF

# Path parameters
export rule_id="CHANGE_ME"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "incident_rules"
  }
}
EOF