Skip to main content

Overview

Retrieve a paginated list of all incidents on a specific status page. Filter by status, severity, or date range to find specific incidents. Results are returned in reverse chronological order by default.

Authentication

All requests must include authentication via API Key:
  • API Key: X-API-Key: YOUR_API_KEY

Request

curl -X GET "https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents?page=1&limit=20" \
  -H "X-API-Key: YOUR_API_KEY"

Path Parameters

ParameterTypeDescription
projectIdUUIDThe ID of the project
statusPageIdUUIDThe ID of the status page

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number for pagination
limitinteger20Incidents per page (1-100)
statusstring-Filter by status: investigating, identified, monitoring, resolved
severitystring-Filter by severity: minor, major, critical
sort_bystringcreated_atSort field: created_at, updated_at, severity, status
sort_orderstringdescSort direction: asc, desc

Response

Returns a paginated list of incidents.
{
  "success": true,
  "data": {
    "incidents": [
      {
        "id": "990e8400-e29b-41d4-a716-446655440050",
        "status_page_id": "550e8400-e29b-41d4-a716-446655440000",
        "title": "API Service Degradation",
        "message": "We are experiencing elevated response times on our API servers",
        "severity": "major",
        "status": "resolved",
        "affected_monitor_ids": [
          "770e8400-e29b-41d4-a716-446655440010",
          "770e8400-e29b-41d4-a716-446655440011"
        ],
        "created_at": "2024-12-26T11:00:00Z",
        "updated_at": "2024-12-26T13:30:00Z",
        "resolved_at": "2024-12-26T13:30:00Z",
        "updates_count": 3
      },
      {
        "id": "881e8400-e29b-41d4-a716-446655440051",
        "status_page_id": "550e8400-e29b-41d4-a716-446655440000",
        "title": "Database Maintenance",
        "message": "Scheduled maintenance window for database cluster upgrade",
        "severity": "minor",
        "status": "resolved",
        "affected_monitor_ids": [
          "770e8400-e29b-41d4-a716-446655440012"
        ],
        "created_at": "2024-12-25T22:00:00Z",
        "updated_at": "2024-12-25T23:00:00Z",
        "resolved_at": "2024-12-25T23:00:00Z",
        "updates_count": 1
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "total": 42,
      "totalPages": 3,
      "hasNext": true,
      "hasPrevious": false
    }
  }
}

Response Fields

Incidents Array - List of incident objects:
FieldTypeDescription
idUUIDUnique incident identifier
status_page_idUUIDStatus page ID
titlestringIncident title
messagestringIncident description
severitystringSeverity level
statusstringCurrent status
affected_monitor_idsUUID[]List of affected monitors
created_attimestampCreation timestamp
updated_attimestampLast update timestamp
resolved_attimestamp | nullResolution timestamp
updates_countintegerNumber of incident updates
Pagination - Pagination metadata:
FieldTypeDescription
pageintegerCurrent page number
pageSizeintegerItems per page
totalintegerTotal incidents
totalPagesintegerTotal pages
hasNextbooleanMore pages available
hasPreviousbooleanPrevious pages available

Status Codes

StatusDescription
200Successfully retrieved incidents
400Invalid query parameters
401Unauthorized (missing or invalid token)
404Status page not found

Examples

Get All Incidents

curl -X GET https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents \
  -H "X-API-Key: YOUR_API_KEY"

Filter by Status

curl -X GET "https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents?status=investigating" \
  -H "X-API-Key: YOUR_API_KEY"

Filter by Severity

curl -X GET "https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents?severity=critical" \
  -H "X-API-Key: YOUR_API_KEY"

Combined Filters with Pagination

curl -X GET "https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents?status=resolved&severity=major&page=2&limit=50" \
  -H "X-API-Key: YOUR_API_KEY"

Sort by Updated Time

curl -X GET "https://api.uptimeio.com/api/projects/660e8400-e29b-41d4-a716-446655440001/status-pages/550e8400-e29b-41d4-a716-446655440000/incidents?sort_by=updated_at&sort_order=desc" \
  -H "X-API-Key: YOUR_API_KEY"

Error Codes

Invalid Status Filter

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid query parameters",
    "details": [
      {
        "field": "status",
        "message": "Status must be one of: investigating, identified, monitoring, resolved"
      }
    ]
  }
}

Status Page Not Found

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Status page not found"
  }
}

Unauthorized

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}