Skip to content
Pile
Esc
navigateopen⌘Jpreview

Get health

GET/health
Responses
200Healthy or degraded
okbooleanrequired
statusstringrequired
Allowed:healthydegradedunhealthy
versionstringrequired
checksobject[]required
Show properties
Array of object
namestringrequired
healthybooleanrequired
messagestring
503Unhealthy
okbooleanrequired
statusstringrequired
Allowed:healthydegradedunhealthy
versionstringrequired
checksobject[]required
Show properties
Array of object
namestringrequired
healthybooleanrequired
messagestring
Try it
Server
Request
curl -X GET "/health"
Response
{
  "ok": true,
  "status": "healthy",
  "version": "string",
  "checks": [
    {
      "name": "string",
      "healthy": true,
      "message": "string"
    }
  ]
}