API Documentation

Programmatically manage your status page with our REST API. Full access to components, incidents, maintenance, and subscribers.

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer your_api_key_here

API keys can be created in your organisation settings. Each key can be scoped to specific permissions (read-only, write, or full access).

https://app.status-quo.tech/api/v1

Manage your status page components and their current status.

GET/api/v1/componentsList all components

POST/api/v1/componentsCreate a new component

GET/api/v1/components/{id}Get a specific component

PATCH/api/v1/components/{id}Update a component

DELETE/api/v1/components/{id}Delete a component

Create and manage incidents with timeline updates.

GET/api/v1/incidentsList all incidents

POST/api/v1/incidentsCreate a new incident

GET/api/v1/incidents/{id}Get a specific incident

PATCH/api/v1/incidents/{id}Update an incident

POST/api/v1/incidents/{id}/updatesAdd an incident update

Schedule and manage planned maintenance windows.

GET/api/v1/maintenanceList all maintenance

POST/api/v1/maintenanceSchedule new maintenance

GET/api/v1/maintenance/{id}Get specific maintenance

PATCH/api/v1/maintenance/{id}Update maintenance

DELETE/api/v1/maintenance/{id}Cancel maintenance

Manage notification subscribers for your status page.

GET/api/v1/subscribersList all subscribers

POST/api/v1/subscribersAdd a new subscriber

DELETE/api/v1/subscribers/{id}Remove a subscriber

API requests are rate limited to ensure fair usage: