Status Pages API (Authenticated)
Last updated: 2026-07-22
The Status Pages API lets you create, read, update, and delete status pages accessible to your account. A single-page response also includes its linked monitors.
Base URL
https://statuspage.me/user/api/v1
Authentication
Read requests require status-pages:read; create, update, and delete requests require status-pages:write. Include an API key as:
Authorization: Bearer spk_...
See API Console for key creation.
Endpoints
List Status Pages
GET /status-pages
Returns all status pages owned by or shared with the authenticated user.
Response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Status",
"slug": "acme",
"url": "https://status.acme.com"
}
]
}
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique status page ID |
name | string | Display name |
slug | string | The slug used in the default URL (slug.statuspage.me) |
url | string | Custom domain URL (only present if a custom domain is configured) |
Get a Single Status Page
GET /status-pages/:id
Returns a single status page with its linked monitors.
Parameters
| Parameter | Type | Description |
|---|---|---|
id | string (UUID) | The status page ID |
Response
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Status",
"slug": "acme",
"monitors": [
{
"id": 42,
"name": "API Gateway",
"type": "site",
"target": "https://api.acme.com/health",
"interval_seconds": 60,
"enabled": true
}
]
}
}
Monitor fields
| Field | Type | Description |
|---|---|---|
id | integer | Monitor ID |
name | string | Monitor display name |
type | string | site, api, dns, or heartbeat |
target | string | The URL, hostname, or endpoint being monitored |
interval_seconds | integer | How often the monitor runs (in seconds) |
enabled | boolean | Whether the monitor is currently active |
Create a Status Page
POST /status-pages
Requires status-pages:write.
{
"name": "Acme Status",
"slug": "acme",
"is_simple": false
}
name and slug are required. Names are limited to 200 characters. The slug is lowercased and must be available; deleted and reserved slugs cannot be reused. Creation is subject to the status-page limit of the account’s plan.
The response is 201 Created with the new page’s id, name, and slug. To make a create safe to retry, send a unique Idempotency-Key header; see Authenticated REST API Overview.
Update a Status Page
PATCH /status-pages/:id
Requires status-pages:write. Send either or both fields:
{
"name": "Acme Platform Status",
"slug": "acme-platform"
}
name and slug cannot be empty. Changing a slug applies the same availability and reserved-slug checks as creation.
Delete a Status Page
DELETE /status-pages/:id
Requires status-pages:write. This soft-deletes the status page and its components. API deletion does not require the interactive confirmation phrase used in the dashboard, so treat it as a destructive operation.
Error Responses
| Status | Meaning |
|---|---|
401 Unauthorized | Missing or invalid API key |
403 Forbidden | Key lacks the required scope |
404 Not Found | Status page not found or you don’t have access |