Appearance
Get operational status
GET /v1/admin/ops/status
- Operation ID:
getOpsStatus - Tags: Operations
- Base URL:
http://localhost:8787
Latest health check per service, all open incidents and the current panic state.
Workflow: Integration guide.
Authentication: staff Bearer JWT with permission ops.read.
Authentication
- Auth: staff Bearer JWT (
Authorization: Bearer <access_token>) with the permissions below. - Required permissions:
ops.read
Responses
200
Current status.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
services | object[] | yes | - |
services[].service | string | yes | - |
services[].ok | boolean | yes | - |
services[].latency_ms | integer | null | yes | - |
services[].error | string | null | yes | - |
services[].checked_at | string<date-time> | yes | - |
incidents | (object (OpsIncident))[] | yes | - |
incidents[].id | string<uuid> | yes | - |
incidents[].service | string | yes | - |
incidents[].severity | string | yes | One of: "warning", "critical" |
incidents[].status | string | yes | One of: "open", "resolved" |
incidents[].opened_at | string<date-time> | yes | - |
incidents[].resolved_at | string<date-time> | null | yes | - |
incidents[].last_error | string | null | yes | - |
incidents[].auto_panic | boolean | yes | Whether this incident automatically raised panic mode. |
panic | object (OpsPanicState) | yes | - |
panic.level | string | yes | One of: "off", "degraded", "lockdown" |
panic.reason | string | null | yes | - |
panic.set_by | string | null | yes | - |
panic.set_at | string | null | yes | - |
panic.auto | boolean | yes | True when set automatically by incident monitoring. |
Errors
401
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}403
Authenticated but lacking the required permission. details.perm lists the accepted permission keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "forbidden",
"details": {
"perm": "ops.read"
}
}500
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples
curl
bash
curl -X GET 'http://localhost:8787/v1/admin/ops/status' \
-H "Authorization: Bearer $ACCESS_TOKEN"TypeScript
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/admin/ops/status", {
method: "GET",
headers: {
"Authorization": `Bearer ${accessToken}`,
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();