Skip to main content

Status Pages

Status pages let you share real-time service health with your users. You control what to show and who can see it.

Creating a status page

POST /api/v1/status-pages
Authorization: Bearer <token>
Content-Type: application/json

{
"name": "Acme Status",
"slug": "acme-status",
"is_public": true
}
FieldTypeRequiredDescription
namestringDisplay name of the status page
slugstringNoURL slug (auto-derived from name if omitted)
is_publicboolNotrue = visible without login; false = private

If slug is omitted, it's automatically derived from the name (lowercased, spaces become -).

Response (201 Created):

{
"id": "uuid",
"organization_id": "org-uuid",
"name": "Acme Status",
"slug": "acme-status",
"is_public": true,
"branding": {},
"created_at": "2026-03-02T00:00:00Z"
}

Managing status pages

# List all status pages for your organization
GET /api/v1/status-pages

# Delete a status page
DELETE /api/v1/status-pages/{id}

Branding

The branding field accepts a freeform JSON object for customization:

POST /api/v1/status-pages
{
"name": "Acme Status",
"is_public": true,
"branding": {
"logo_url": "https://yourco.com/logo.png",
"primary_color": "#2563eb",
"company_name": "Acme Corp"
}
}

Public vs private

is_publicWho can view
trueAnyone with the link
falseOnly authenticated organization members

What's displayed on a status page

The dashboard shows your monitored services and their current status (GREEN, YELLOW, RED). Incidents can be associated with affected services to communicate ongoing issues.


Use cases

  • Public status page — your customers can check https://status.yourco.com
  • Internal status page — your engineering team's private operational dashboard
  • Stakeholder page — a curated view for leadership showing only production services