Skip to main content

Debug

Returns the runtime configuration, active modules, and dependency versions (Chromium, LibreOffice). Useful for troubleshooting and verifying startup flags.

Only available when API_ENABLE_DEBUG_ROUTE is set to true. See the API module configuration.

The route exposes the configuration of every module to anyone who can reach it. Since 8.37.0, Gotenberg logs a warning at startup when the route is enabled without basic or OIDC authentication. Enable one, or keep the route behind a gateway that authenticates for Gotenberg.

Basics​

GET/debug
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/debug
Responses
See https://demo.gotenberg.dev/debug for details.

What's Next?​

Deliver results asynchronously with webhooks, or restrict where Gotenberg can reach with Outbound URL filtering.