Skip to main content
Detailed health report
curl --request GET \
  --url http://localhost:3001/health/detailed
{
  "status": "ok",
  "version": "0.1.0",
  "timestamp": "2026-02-25T12:00:00Z",
  "uptime_seconds": 86400,
  "storage": {
    "status": "healthy",
    "connected": true
  }
}

Headers

Accept
enum<string>
Available options:
application/json,
application/x-protobuf

Response

Full health report.

Comprehensive health report returned by GET /health/detailed.

status
string
required

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

Example:

"ok"

version
string
required

Crate version string (from CARGO_PKG_VERSION).

Example:

"0.1.0"

timestamp
string<date-time>
required

Current UTC timestamp in RFC 3339 / ISO 8601 format.

Example:

"2026-02-25T12:00:00Z"

uptime_seconds
integer<int64>
required

Elapsed seconds since the service process started.

Example:

86400

storage
object
required

Storage backend connectivity sub-report embedded in DetailedHealthResponse.