GEgetorchestra
Incidents

Update an incident

Changed on

Change an incident's status, severity, name, assignee or subscribers. A field left out of the request body keeps its stored value, and sending assignee as null unassigns. An assignee or subscriber must be able to view the incident or be in the account's Slack workspace.

Returns the detail shape - a patch writes timeline rows of its own, so the caller's event count is out of date the moment the change lands.

patch/incidents/{incident_id}

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/incidents/{incident_id}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:write

Path parameters

incident_idstring uuid4 required

Incident ID.

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Request body

status'DISMISSED' | 'INVESTIGATING' | 'OPEN' | 'RESOLVED'
severity'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW'
namestring nullable
descriptionstring nullable

Response

Successful Response

incidentIdstring uuid4 required
status'DISMISSED' | 'INVESTIGATING' | 'OPEN' | 'RESOLVED' required
severity'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW' required
namestring nullable
descriptionstring nullable
assigneestring nullable
subscribersstring[]
parentIncidentIdstring uuid4 nullable
createdAtstring required
updatedAtstring required
resolvedAtstring nullable
resolvedBystring uuid4 nullable
resolvedByType'AI' | 'API' | 'OTHER' | 'SYSTEM' | 'USER'
archivedAtstring nullable
mutedAtstring nullable
isMutedboolean
mutedUntilstring nullable
monitorIdstring uuid4 nullable
eventCountinteger required
childCountinteger required

Changes