Health Check

Returns the operational status of the API and its modules.

This endpoint verifies that the server is accepting requests and that all active modules (Chromium, LibreOffice) are in a healthy state. It returns a JSON object detailing the status of each subsystem. It is designed for use by container orchestrators (e.g., Kubernetes Liveness Probes) or monitoring agents.

GET/health

Headers

Gotenberg-Tracestring

A custom request ID to identify the request in the logs; overrides the default UUID.

Example Request

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

Responses

200 OK
503 Service Unavailable

The service is healthy.

{
  status: "up",
  details: {
    chromium: {
      status: "up",
      timestamp: "2021-07-01T08:05:14.603364Z",
    },
    libreoffice: {
      status: "up",
      timestamp: "2021-07-01T08:05:14.603364Z",
    },
  },
}

The service in unhealthy.

{
  status: "down",
  details: {
    chromium: {
      status: "up",
      timestamp: "2021-07-01T08:05:14.603364Z",
    },
    libreoffice: {
      status: "down",
      timestamp: "2021-07-01T08:05:14.603364Z",
      error: "LibreOffice is unhealthy",
    },
  },
}

❤️ Become a sponsor