Error
A valid request URL is required to generate request examples{
"status": "healthy",
"service": "api",
"revision": "340d8847ab12",
"uptime_seconds": 123,
"node_version": "v20.18.0",
"database": {
"status": "connected",
"latency_ms": 123
},
"memory": {
"rss_mb": 123,
"heap_used_mb": 123,
"heap_total_mb": 123
}
}API Reference
Detailed health check
Returns service health with database connectivity, uptime, memory usage, and Node.js version. Requires a session: it reports the runtime build and the tenant’s inventory, which are not public facts. /health is the public liveness probe.
GET
/
health
/
detailed
Error
A valid request URL is required to generate request examples{
"status": "healthy",
"service": "api",
"revision": "340d8847ab12",
"uptime_seconds": 123,
"node_version": "v20.18.0",
"database": {
"status": "connected",
"latency_ms": 123
},
"memory": {
"rss_mb": 123,
"heap_used_mb": 123,
"heap_total_mb": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Detailed health status
Available options:
healthy, degraded Example:
"api"
The commit this container was built from, or "unstamped" if it predates the deploy stamp. Reported here and not on /health, which is public.
Example:
"340d8847ab12"
Example:
"v20.18.0"
Show child attributes
Show child attributes
Show child attributes
Show child attributes