Skip to main content

Base URL

All API requests should be made to:

Authentication

Authenticate requests using the X-API-Key header:
You can also use the Authorization: Bearer header as an alternative:

Get Your API Key

Generate an API key from your dashboard

Response Format

All responses are returned in JSON format:

Error Handling

Errors return appropriate HTTP status codes with a JSON body:
Some endpoints include additional detail for validation errors:

Rate Limits

Rate limit headers are included in responses:

API Categories

Status Pages

Create and configure status pages

Status Page Design

Draft, validate, and publish page designs with versioning

Incidents

Create and manage incidents

Services

Manage status page services

Uptime Monitors

HTTP endpoint monitoring

Heartbeat

Monitor background jobs

Notifications

Configure alert channels

Webhooks

Receive real-time events