Appearance
Status API
4 operations. Paths are relative to the API host (http://localhost:5080 in local development). Every operation accepts an OIDC bearer token (Authorization: Bearer …) or a workspace API key (X-Api-Key: keel_live_…); errors are RFC 9457 Problem Details with a code (error codes). Permissions: matrix.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/status/page | The public status page (anonymous): six components now and over 90 days, open and past incidents. No tenant data. |
| POST | /api/v1/status/subscriptions | Subscribe an email to status updates (double opt-in): 202 whether or not it was subscribed already; a confirmation email follows. |
| POST | /api/v1/status/subscriptions:confirm | Confirm a status subscription with the token from the confirmation email (400 Status.LinkInvalid when it is not valid). |
| POST | /api/v1/status/subscriptions:unsubscribe | Unsubscribe with the token from a status email: the address is deleted. |
GetStatusPage
http
GET /api/v1/status/pageThe public status page (anonymous): six components now and over 90 days, open and past incidents. No tenant data.
| Status | Description | Body |
|---|---|---|
| 200 | OK | StatusPageDto |
| 429 | Too Many Requests | ProblemDetails |
Response 200: StatusPageDto
| Field | Type | Notes |
|---|---|---|
active | StatusIncidentDto[] | |
components | StatusComponentPageDto[] | |
generatedAt | date-time | |
overall | ComponentState | One of Operational, Maintenance, Degraded, Outage |
past | StatusIncidentDto[] | |
region | StatusRegionDto | |
regions | StatusRegionDto[] |
SubscribeToStatus
http
POST /api/v1/status/subscriptionsSubscribe an email to status updates (double opt-in): 202 whether or not it was subscribed already; a confirmation email follows.
Request body (application/json): StatusSubscriptionRequest
| Field | Type | Notes |
|---|---|---|
email | string |
| Status | Description | Body |
|---|---|---|
| 202 | Accepted | — |
| 400 | Bad Request | ProblemDetails |
| 429 | Too Many Requests | ProblemDetails |
ConfirmStatusSubscription
http
POST /api/v1/status/subscriptions:confirmConfirm a status subscription with the token from the confirmation email (400 Status.LinkInvalid when it is not valid).
Request body (application/json): StatusLinkRequest
| Field | Type | Notes |
|---|---|---|
token | string |
| Status | Description | Body |
|---|---|---|
| 204 | No Content | — |
UnsubscribeFromStatus
http
POST /api/v1/status/subscriptions:unsubscribeUnsubscribe with the token from a status email: the address is deleted.
Request body (application/json): StatusLinkRequest
| Field | Type | Notes |
|---|---|---|
token | string |
| Status | Description | Body |
|---|---|---|
| 204 | No Content | — |