For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/incidents/update-an-incident-impact.md. A documentation index is available at /llms.txt.
Language
Datadog site

Update an incident impact

WARNINGNote: 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/{incident_id}/impacts/{impact_id}https://api.us3.datadoghq.com/api/v2/incidents/{incident_id}/impacts/{impact_id}https://api.us5.datadoghq.com/api/v2/incidents/{incident_id}/impacts/{impact_id}https://api.datadoghq.eu/api/v2/incidents/{incident_id}/impacts/{impact_id}https://api.ap1.datadoghq.com/api/v2/incidents/{incident_id}/impacts/{impact_id}https://api.ap2.datadoghq.com/api/v2/incidents/{incident_id}/impacts/{impact_id}https://api.uk1.datadoghq.com/api/v2/incidents/{incident_id}/impacts/{impact_id}https://api.ddog-gov.com/api/v2/incidents/{incident_id}/impacts/{impact_id}https://api.us2.ddog-gov.com/api/v2/incidents/{incident_id}/impacts/{impact_id}

Overview

Update an incident impact.

This endpoint requires the incident_write permission.

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

Arguments

Path Parameters

Name
Type
Description
incident_id [required]
string

The UUID of the incident.

impact_id [required]
string

The UUID of the incident impact.

Query Strings

Name
Type
Description
include
array

Specifies which related resources should be included in the response.

Request

Body Data (required)

Incident impact patch payload.

Field
Type
Description
data [required]
object

Incident impact data for a patch request.

Response

OK

Response with an incident impact.

Field
Type
Description
data [required]
object

Incident impact data from a response.

included
[object]

Included related resources that the user requested.

Code Example

# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
export impact_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/${incident_id}/impacts/${impact_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Patched service impact description"
    },
    "type": "incident_impacts"
  }
}
EOF