Authenticated REST API
The StatusPage.me authenticated API lets you read and write your status page data from your own applications, CI pipelines, on-call tools, and monitoring integrations.
Availability
API access is available on the Pro, Growth, Business, and Enterprise plans. Upgrade your plan if needed.
Base URL
https://statuspage.me/user/api/v1
Authentication
Generate an API key from the API Console. Then include it in every request using one of:
Authorization: Bearer spk_...
or
X-API-Key: spk_...
Tokens start with spk_ and are shown only once at creation. Store them securely.
Scopes
When creating a key you can restrict it to specific scopes. An empty scope list means full access.
| Scope | Description |
|---|---|
monitors:read | Read monitors |
monitors:write | Create, update, and delete monitors |
incidents:read | Read incidents and updates |
incidents:write | Create incidents, append timeline updates, and archive eligible resolved incidents |
maintenances:read | Read maintenance windows |
maintenances:write | Create, update, and delete maintenance windows |
status-pages:read | Read status pages and metrics |
status-pages:write | Create, update, and delete status pages; update metric values |
metrics:write | Create, update, and delete metrics |
analytics:read | Read availability/uptime metrics |
account:reset | Reset the operational workspace and create a 30-day restore snapshot |
Response Format
All endpoints return JSON. Successful responses use this envelope:
{
"data": { ... },
"meta": { "count": 5 }
}
Errors return:
{
"error": "human-readable message"
}
HTTP Status Codes
| Code | Meaning |
|---|---|
200 | OK |
201 | Created |
400 | Bad request (validation error) |
401 | Unauthorized — missing or invalid API key |
403 | Forbidden — API key lacks required scope |
404 | Not found or access denied |
500 | Internal server error |
Safe retries for creates
The create endpoints for status pages, monitors, incidents, maintenances, and metrics support an optional Idempotency-Key header. Send a unique key for each logical create operation so a retry after a timeout returns the original successful response instead of creating a duplicate.
Idempotency-Key: deploy-2026-07-22-001
Reuse the key only with the exact same request body. Reusing it with a different body returns 409 Conflict. Keys may be up to 255 characters long.
Rate Limiting
API requests are subject to the same rate limits as other requests. If you need higher limits, contact support.
Available Resources
| Resource | Article |
|---|---|
| Monitors & availability | Monitors API |
| Incidents (CRUD) | Incidents API |
| Maintenances (CRUD) | Maintenances API |
| Status Pages (CRUD) | Status Pages API |
| Live metrics (CRUD) | Metrics API |
Managing API Keys
Visit the API Console to create, view usage logs, and revoke your API keys.
See also: API Keys