pub.chive.admin.getSystemHealth

Get health status of all database connections

Repository @lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh not from the namespace authority
Details · query
Kindquery
Authorityadmin.chive.pub
Indexed

Query

query · GET

Parameters

query string

Output

application/json

databases

requiredarray

Health status for each database connection

itemsref
Reference

status

requiredstring

Overall system health status

  • knownValues: healthy | degraded | unhealthy

timestamp

requiredstring · datetime

Timestamp of the health check

uptime

requiredinteger

Server uptime in seconds

Errors

AuthenticationRequired

No description in schema.

AdminRequired

No description in schema.

#databaseHealth

object

Health status of a single database connection

Properties

error

string

Error message if unhealthy

healthy

requiredboolean

Whether the database is reachable

latencyMs

integer

Connection latency in milliseconds

name

requiredstring

Database name