Skip to main content

​
Overview

Acknowledge an incident in a single request. This is a convenience endpoint that transitions an incident from open status to acknowledged. It’s equivalent to calling the status update endpoint with status: 'acknowledged'.

​
Authentication

Requires API Key authentication:
  • API Key: X-API-Key: YOUR_API_KEY

​
Path Parameters

​
id
string
required
Incident ID (UUID). The unique identifier of the incident to acknowledge.

​
Request Body

No request body required. The endpoint automatically:
  • Sets status to acknowledged
  • Assigns the incident to the authenticated user
  • Records the current timestamp as acknowledged_at

​
Response Format

​
success
boolean
Whether the request was successful
​
data
object

​
Example Requests

curl -X POST 'https://api.uptimeio.com/api/incidents/550e8400-e29b-41d4-a716-446655440000/acknowledge' \
  -H 'X-API-Key: YOUR_API_KEY'

​
Example Response

{
  "success": true,
  "data": {
    "incident": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "check_id": "660e8400-e29b-41d4-a716-446655440000",
      "check_name": "API Health Check",
      "check_url": "https://api.example.com/health",
      "status": "acknowledged",
      "severity": "critical",
      "type": "timeout",
      "title": "API Health Check - Timeout",
      "error_message": "Request timeout after 5000ms",
      "started_at": 1703001600000,
      "resolved_at": null,
      "acknowledged_at": 1703001660000,
      "affected_regions": ["us-east-1", "eu-west-1"],
      "failure_count": 3,
      "notification_sent": true,
      "created_at": 1703001600000,
      "updated_at": 1703001660000
    },
    "recovery_time_seconds": null
  }
}

​
Status Codes

StatusDescription
200 OKIncident successfully acknowledged
400 Bad RequestInvalid state transition (e.g., already resolved)
401 UnauthorizedAuthentication failed or invalid credentials
404 Not FoundIncident not found or not accessible in current project
500 Internal Server ErrorServer error during acknowledgment

​
Error Codes

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Cannot transition from resolved to acknowledged. Valid transitions: closed",
    "details": {
      "fromStatus": "resolved",
      "toStatus": "acknowledged",
      "validTransitions": ["closed"]
    }
  }
}

​
Comparison with Update Status Endpoint

This endpoint is a convenience wrapper around the status update endpoint:
FeatureAcknowledgeUpdate Status
PurposeQuick acknowledgmentFull status control
Valid Statusacknowledged onlyopen, acknowledged, resolved, closed
Note/CommentAutomaticOptional
Request BodyEmptyRequired
Use CaseMobile apps, quick actionsFull workflow control

​
Equivalent Calls

These two calls are functionally equivalent: 
# Using acknowledge endpoint
POST /api/incidents/{id}/acknowledge
X-API-Key: YOUR_API_KEY

# Equivalent using status endpoint
PUT /api/incidents/{id}/status
X-API-Key: YOUR_API_KEY
Content-Type: application/json

{
  "status": "acknowledged",
  "note": "Incident acknowledged"
}

​
Notes

  • No request body is required - send POST with empty body
  • The endpoint automatically assigns the incident to the authenticated user
  • The acknowledged_at timestamp is set to the current server time
  • Transition rules still apply - cannot acknowledge already resolved incidents
  • Attempting to acknowledge an already-acknowledged incident returns a 400 Bad Request error with valid transitions listed
  • The note is automatically set to “Incident acknowledged”

​
Valid State Transitions

This endpoint only works when transitioning from open status: 
open ──acknowledge──> acknowledged
Any other current status will result in a 400 Bad Request error indicating the valid transitions from that state.