Overview
Add a status update to an existing incident. Updates allow you to communicate progress to status page viewers as you investigate, identify, and resolve issues. Each update is timestamped and appears in the incident timeline.Authentication
All requests must include authentication via API Key:- API Key:
X-API-Key: YOUR_API_KEY
Request
Path Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | UUID | The ID of the project |
statusPageId | UUID | The ID of the status page |
id | UUID | The ID of the incident |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
message | string | Yes | Update message (1-5000 characters) |
status | string | Yes | Current status: investigating, identified, monitoring, resolved |
Response
Returns the created update with a 201 status code.Response Fields
| Field | Type | Description |
|---|---|---|
id | UUID | Unique update identifier |
incident_id | UUID | Parent incident ID |
message | string | Update message |
status | string | Status at time of update |
created_at | timestamp | Creation timestamp |
created_by | string | User ID or “system” |
Status Codes
| Status | Description |
|---|---|
201 | Update created successfully |
400 | Validation error (invalid data) |
401 | Unauthorized (missing or invalid token) |
403 | Forbidden (no permission to update incident) |
404 | Incident or status page not found |