Skip to content
Open Markdown

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

FieldTypeRequiredDescription
servicesobject[]yes-
services[].servicestringyes-
services[].okbooleanyes-
services[].latency_msinteger | nullyes-
services[].errorstring | nullyes-
services[].checked_atstring<date-time>yes-
incidents(object (OpsIncident))[]yes-
incidents[].idstring<uuid>yes-
incidents[].servicestringyes-
incidents[].severitystringyesOne of: "warning", "critical"
incidents[].statusstringyesOne of: "open", "resolved"
incidents[].opened_atstring<date-time>yes-
incidents[].resolved_atstring<date-time> | nullyes-
incidents[].last_errorstring | nullyes-
incidents[].auto_panicbooleanyesWhether this incident automatically raised panic mode.
panicobject (OpsPanicState)yes-
panic.levelstringyesOne of: "off", "degraded", "lockdown"
panic.reasonstring | nullyes-
panic.set_bystring | nullyes-
panic.set_atstring | nullyes-
panic.autobooleanyesTrue 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)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional 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();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

GET/v1/admin/ops/status

Your token stays in this tab's memory and is sent only when you press Send request.

Built for developers. Ready for agents.