Developers

API Reference

Integrate status updates into your workflows with our REST API. Full programmatic access to all platform features.

Base URL

https://api.status.example.com/v2

Authentication

All API requests require an API key passed in the Authorization header:

curl -H "Authorization: Bearer sk_live_xxxxx" \
  https://api.status.example.com/v2/status

Endpoints

GET
/api/v2/status

Get the current status of all components.

GET
/api/v2/components

List all monitored components.

POST
/api/v2/incidents

Create a new incident.

PATCH
/api/v2/incidents/:id

Update an existing incident.

GET
/api/v2/metrics

Retrieve uptime and latency metrics.

POST
/api/v2/maintenance

Schedule a maintenance window.

SDKs & Libraries

Official client libraries for popular languages.

Node.jsnpm install @status/sdk
Pythonnpm install @status/sdk
Gonpm install @status/sdk
Full documentationGet API access