Overview Add a comment or update to an incident for team collaboration and incident history tracking. Comments are stored in the incident timeline and can be viewed by all team members with access to the incident.
Authentication Requires API Key authentication:
API Key : X-API-Key: YOUR_API_KEY
Path Parameters Incident ID (UUID). The unique identifier of the incident to add an update to.
Request Body The comment or update message. Minimum 1 character, maximum 1000 characters.
Whether the comment was added successfully
Show Response data object
Unique comment/update identifier (UUID)
User ID of the person who added the comment
The type of update action. For comments, this is always comment_added
ISO 8601 timestamp when the comment was created
Example Requests curl -X POST 'https://api.uptimeio.com/api/incidents/550e8400-e29b-41d4-a716-446655440000/updates' \ -H 'X-API-Key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "message": "Found the root cause - database replication lag. Restarting standby replicas." }'
Example Response { "success" : true , "data" : { "id" : "990e8400-e29b-41d4-a716-446655440001" , "incident_id" : "550e8400-e29b-41d4-a716-446655440000" , "user_id" : "aa0e8400-e29b-41d4-a716-446655440000" , "action" : "comment_added" , "message" : "Found the root cause - database replication lag. Restarting standby replicas." , "created_at" : "2024-12-26T14:30:00Z" } }
Status Codes Status Description 201 Created Comment successfully added 400 Bad Request Invalid message format or validation error 401 Unauthorized Authentication failed or invalid credentials 404 Not Found Incident not found or not accessible in current project 500 Internal Server Error Server error during comment creation
Error Codes { "success" : false , "error" : { "code" : "VALIDATION_ERROR" , "message" : "Invalid request parameters" , "details" : { "message" : "Message cannot exceed 1000 characters" } } }
Use Cases Investigation Progress Document the investigation process:
{ "message" : "Checking application logs for errors around 2024-12-26T14:00:00Z" }
Root Cause Documentation Record the root cause analysis:
{ "message" : "Root cause identified: Memory leak in payment processor service. OOM killer triggered at 14:25 UTC. Applying fix from PR #4521" }
Resolution Steps Document the fix that was applied:
{ "message" : "Applied hotfix: rolled back recent database migration. Service is now recovering." }
Post-Incident Notes Add post-mortem information:
{ "message" : "Post-mortem scheduled for tomorrow 10am PT. Will review monitoring gaps that allowed this to persist for 2 hours." }
Communication to Team Keep team informed of status:
{ "message" : "Failover to backup cluster in progress. Estimating 5-10 minute window for partial availability." }
Viewing Updates Updates can be retrieved using the Get Incident Updates endpoint:
GET /api/incidents/{id}/updates
This returns all comments and status changes in chronological order, providing a complete timeline of the incident.
Notes
Comments are attributed to the authenticated user making the request
The message must be between 1 and 1000 characters
Comments are stored in chronological order in the timeline
All team members with access to the incident can view comments
Comments cannot be edited through the API (only created)
Comments help maintain a clear communication record during incidents
