Files
gotenberg/build/docs/content/13-ping.md

42 lines
1015 B
Markdown

---
title: Ping
---
Gotenberg provides the endpoint `/ping` for checking the API availability with
a simple `GET` request.
This feature is especially useful for liveness/readiness probes in Kubernetes:
* [Pod lifecycle](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
* [Configure Liveness and Readiness Probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/)
If `LOG_LEVEL` is `"DEBUG"`, it also returns details about the PM2 processes in JSON format.
For instance:
```json
[
{
"name": "google-chrome-stable",
"pm2_env": {
"status": "online",
"restart_time": 0
},
"monit": {
"memory": 72294400,
"cpu": 0
}
},
{
"name": "unoconv",
"pm2_env": {
"status": "online",
"restart_time": 0
},
"monit": {
"memory": 71000064,
"cpu": 0
}
}
]
```