pub.chive.admin.getSystemHealth Documentation (EN)

main query

Get health status of all database connections

Output

Encodingapplication/json

databases array Required

Health status for each database connection

status string Required

Overall system health status

Known values: healthy, degraded, unhealthy

timestamp stringdatetime Required

Timestamp of the health check

uptime integer Required

Server uptime in seconds

Errors

AuthenticationRequired

AdminRequired

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "status",
        "databases",
        "uptime",
        "timestamp"
      ],
      "properties": {
        "status": {
          "type": "string",
          "description": "Overall system health status",
          "knownValues": [
            "healthy",
            "degraded",
            "unhealthy"
          ]
        },
        "uptime": {
          "type": "integer",
          "description": "Server uptime in seconds"
        },
        "databases": {
          "type": "array",
          "items": {
            "ref": "#databaseHealth",
            "type": "ref"
          },
          "description": "Health status for each database connection"
        },
        "timestamp": {
          "type": "string",
          "format": "datetime",
          "description": "Timestamp of the health check"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {}
  },
  "description": "Get health status of all database connections"
}

databaseHealth object

Health status of a single database connection

Properties

error string Optional

Error message if unhealthy

healthy boolean Required

Whether the database is reachable

latencyMs integer Optional

Connection latency in milliseconds

name string Required

Database name

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "healthy"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Database name"
    },
    "error": {
      "type": "string",
      "description": "Error message if unhealthy"
    },
    "healthy": {
      "type": "boolean",
      "description": "Whether the database is reachable"
    },
    "latencyMs": {
      "type": "integer",
      "description": "Connection latency in milliseconds"
    }
  },
  "description": "Health status of a single database connection"
}