v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBIncidents
Create an incident impact
Create an impact for an incident.
post/api/v2/incidents/{incident_id}/impacts
Path parameters
incident_idstring required
The UUID of the incident.
Query parameters
includeIncidentImpactRelatedObject[]
Specifies which related resources should be included in the response.
Request body
Example request
{
"data": {
"attributes": {
"description": "Service was unavailable for external users",
"end_at": "2025-08-29T13:17:00Z",
"fields": {
"customers_impacted": "all",
"products_impacted": [
"shopping",
"marketing"
]
},
"start_at": "2025-08-28T13:17:00Z"
},
"type": "incident_impacts"
}
}Response
CREATED
Example response
{
"data": {
"attributes": {
"created": "2025-08-29T13:17:00Z",
"description": "Service was unavailable for external users",
"end_at": "2025-08-29T13:17:00Z",
"fields": {
"customers_impacted": "all",
"products_impacted": [
"shopping",
"marketing"
]
},
"impact_type": "customer",
"modified": "2025-08-29T13:17:00Z",
"start_at": "2025-08-28T13:17:00Z"
},
"id": "00000000-0000-0000-1234-000000000000",
"relationships": {
"created_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"incident": {
"data": {
"id": "00000000-0000-0000-1234-000000000000",
"type": "incidents"
}
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
}
},
"type": "incident_impacts"
},
"included": [
{
"type": "users"
}
]
}