Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chromiumly.dev/llms.txt

Use this file to discover all available pages before exploring further.

All methods are static. They call the configured Gotenberg endpoint from Chromiumly.configure().

​
getHealth()

Get the JSON health report from GET /health. 
System.getHealth(): Promise<Buffer>

​
headHealth()

Run a lightweight health check with HEAD /health. Returns an empty buffer on success. 
System.headHealth(): Promise<Buffer>

​
getVersion()

Get the Gotenberg version from GET /version. 
System.getVersion(): Promise<Buffer>

​
getDebug()

Get debug data from GET /debug. 
System.getDebug(): Promise<Buffer>
This endpoint is available only when Gotenberg enables debug data.

​
getPrometheusMetrics()

Get Prometheus metrics from GET /prometheus/metrics. 
System.getPrometheusMetrics(): Promise<Buffer>