Health

Reports whether Gotenberg and each of its engines are up, for probes and load balancers.

GETHEAD/health

Response

JSON, whose status is up, or down with a 503 when an engine is down. HEAD answers the status alone.

curl \
  --request GET http://localhost:3000/health

Response

{
  "status": "up",
  "details": {
    "chromium": {
      "status": "up",
      "timestamp": "2026-11-01T17:31:16.526522968Z"
    },
    "libreoffice": {
      "status": "up",
      "timestamp": "2026-11-01T17:31:16.514805871Z"
    }
  }
}

An engine that's down turns the status to down, with its error, and the answer to 503 Service Unavailable. HEAD /health answers the same status, without the body:

curl \
  --head http://localhost:3000/health

/health never needs credentials, even with authentication on, so probes work without them. Gotenberg doesn't log or trace it, unless --api-disable-health-check-route-telemetry is false.