Check Gotenberg PDF conversion health

GET

/api/ip/pdf-health

const url = 'https://example.com/api/ip/pdf-health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/ip/pdf-health

Check whether Gotenberg PDF conversion is enabled and healthy.

Allows operators to verify Gotenberg connectivity without generating a document. No auth required — returns only boolean status, not sensitive data.

Responses

200

Successful Response

application/json

IPPdfHealthResponse

Gotenberg PDF conversion health status.

object

enabled

required

Enabled

boolean

healthy

Healthy

boolean

gotenberg_url

Any of:

string
null

string

Example

{
  "healthy": false
}