Sign in

v3

latestOpenAPI 3.0.3raw.githubusercontent.com2026-04-10101545.6 KB
health

Detailed health report

Returns a comprehensive health report including service version, process uptime, and storage backend connectivity status.

Content negotiation: Accept: application/x-protobuf returns a Protobuf-encoded DetailedHealthResponse; otherwise JSON.

Note: A 200 OK does not guarantee all dependencies are healthy. Inspect storage.connected to confirm the backend is reachable.

get/health/detailed

Headers

Accept'application/json' | 'application/x-protobuf'

Response

Full health report.

statusstring required

Overall service status ("ok" when all components are healthy).

versionstring required

Crate version string (from CARGO_PKG_VERSION).

timestampstring date-time required

Current UTC timestamp in RFC 3339 / ISO 8601 format.

uptime_secondsinteger required

Elapsed seconds since the service process started.

Example response

{
  "status": "ok",
  "version": "0.1.0",
  "timestamp": "2026-02-25T12:00:00Z",
  "uptime_seconds": 86400,
  "storage": {
    "status": "healthy",
    "connected": true
  }
}