Detailed health check

Returns per-dependency health status (database, redis)

GET/v1/healthz

Responses

200OK

dependenciesobject

errorstring

statusstringrequired

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/healthz"

const response = await fetch("/v1/healthz", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/healthz",
)

Response

{
  "dependencies": {},
  "error": "string",
  "status": "healthy"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}