Components
Define and manage the services displayed on your status page.
Components represent the services, systems, or infrastructure that you want to track and display on your public status page.
Component Status
Each component has one of the following statuses:
| Status | Description |
|---|---|
operational | Service is running normally |
degraded | Service is functional but experiencing reduced performance |
partial_outage | Some aspects of the service are unavailable |
major_outage | Service is completely unavailable |
maintenance | Service is under planned maintenance |
Display Ordering
Components appear on the status page in the order you define. Set the displayOrder field to control positioning — lower numbers appear first.
Public and Private Components
Each component has an isPublic flag:
- Public components are visible on the public status page and included in the public API
- Private components are only visible in the admin dashboard — useful for internal services you want to monitor without exposing to end users
Monitor Linking
Each monitor is linked to a component via its componentId. When a monitor's failure threshold is breached, the linked component's status is automatically updated to major_outage. When checks recover, the status returns to operational.
A component can have multiple monitors attached to it.
Manual Status Updates
You can manually set a component's status at any time, independent of monitors:
PATCH /api/v1/admin/components/:id/status{
"status": "degraded"
}This is useful when you're aware of an issue that monitors haven't detected yet, or when you want to communicate a known limitation.
API Reference
See Admin Endpoints — Components for the full API.