Skip to main content
PATCH
/
api
/
v1
/
incidents
/
{id}
Update incident
curl --request PATCH \
  --url https://app.larm.dev/api/v1/incidents/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "impact": "<string>",
  "status": "<string>",
  "message": "<string>",
  "status_page_id": "<string>",
  "components": [
    {}
  ]
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "API outage",
    "type": "incident",
    "status": "resolved",
    "impact": "major",
    "auto_created": false,
    "started_at": "2026-03-28T12:00:00Z",
    "resolved_at": "2026-03-28T13:00:00Z",
    "updates": [
      {
        "id": "880e8400-e29b-41d4-a716-446655440000",
        "status": "resolved",
        "body": "Issue fixed. All services operational.",
        "posted_at": "2026-03-28T13:00:00Z",
        "posted_by": "user@example.com"
      }
    ],
    "affected_components": [],
    "inserted_at": "2026-03-28T12:00:00Z",
    "updated_at": "2026-03-28T13:00:00Z"
  }
}
Requires incidents:read_write permission. All fields are optional. A single call can update the title, add a timeline message, publish to a status page, and resolve — all at once.
​
id
string
required
Incident UUID
​
title
string
Update the incident title
​
impact
string
minor, major, or critical
​
status
string
Advance the incident status. Setting to resolved or completed resolves the incident.Incident statuses: investigating, identified, monitoring, resolvedMaintenance statuses: scheduled, in_progress, completed
​
message
string
Adds a timeline entry with this message. If status is also provided, the entry reflects the new status.
​
status_page_id
string
UUID of the status page to publish to. Must be used together with components.
​
components
object[]
Components to mark as affected. Each object has id (component UUID) and status (major_outage, partial_outage, degraded_performance, under_maintenance, or operational).
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "API outage",
    "type": "incident",
    "status": "resolved",
    "impact": "major",
    "auto_created": false,
    "started_at": "2026-03-28T12:00:00Z",
    "resolved_at": "2026-03-28T13:00:00Z",
    "updates": [
      {
        "id": "880e8400-e29b-41d4-a716-446655440000",
        "status": "resolved",
        "body": "Issue fixed. All services operational.",
        "posted_at": "2026-03-28T13:00:00Z",
        "posted_by": "user@example.com"
      }
    ],
    "affected_components": [],
    "inserted_at": "2026-03-28T12:00:00Z",
    "updated_at": "2026-03-28T13:00:00Z"
  }
}