Platform: System Health

Version, deployed commit, database size, user/workspace counts and the job queue's stats (platform staff). AI provider budgets are on `GET /ai/usage`.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.

GET/api/v1/platform/health

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Response Body

curl -X GET "http://localhost:8000/api/v1/platform/health"

curl -X GET "http://localhost:8000/api/v1/platform/health"

{
  "version": "string",
  "deploy_commit": "string",
  "app_env": "string",
  "db_size_bytes": 0,
  "counts": {
    "users": 0,
    "workspaces": 0,
    "suspended_workspaces": 0,
    "platform_staff": 0
  },
  "jobs": {}
}

Empty

Authorization

Response Body

200

403