Public Endpoints

Public endpoints provide read-only access to your status page data. No authentication is required.

Status Summary

GET /api/v1/status

Returns the full status summary including overall status, components, active incidents, and upcoming maintenance.

{
  "status": "operational",
  "components": [...],
  "activeIncidents": [...],
  "upcomingMaintenance": [...]
}

GET /api/v1/status/components

Returns all public components with their current status.

[
  {
    "id": "abc123",
    "name": "API",
    "description": "Core API service",
    "status": "operational",
    "displayOrder": 1
  }
]

GET /api/v1/status/uptime

Returns uptime percentages for configurable time periods.

Parameter	Type	Default	Description
`period`	string	`90d`	Time period: `24h`, `7d`, `30d`, `90d`

[
  {
    "componentId": "abc123",
    "componentName": "API",
    "uptimePercentage": 99.98,
    "period": "90d"
  }
]

GET /api/v1/status/incidents

Returns recent incidents, ordered by most recent first.

Parameter	Type	Default	Description
`limit`	number	`20`	Max incidents to return
`offset`	number	`0`	Pagination offset
`status`	string	—	Filter by status

GET /api/v1/status/incidents/:id

Returns a single incident with its full timeline of updates.

GET /api/v1/status/maintenance

Returns upcoming and active maintenance windows.

GET /api/v1/status/rss

Returns an RSS feed of recent incidents and maintenance events.

POST /api/v1/subscribe

Subscribe an email address to status updates.

{
  "email": "[email protected]"
}

GET /api/v1/subscribe/verify/:token

Verifies an email subscription using the token sent via email.

POST /api/v1/unsubscribe

Unsubscribe an email address from status updates.

{
  "email": "[email protected]",
  "token": "unsubscribe_token"
}