Documentation menu

API reference

Health & configuration

Unauthenticated liveness/readiness endpoints for your monitoring, plus a per-session state view.

GET/health/liveLiveness
GET/health/readyReadiness
GET/health/clientsPer-session state
GET/configRuntime configuration
GET/health/live

Liveness

No auth. The API process is up.

No parameters

Response · 200
{ "status": "ok", "podName": "node-0", "uptime": "37h12m4s" }
GET/health/ready

Readiness

No auth. 200 when the platform can serve requests; 503 while its database is unreachable.

No parameters

Response · 200
{ "status": "ok", "podName": "node-0", "database": true, "storage": true, "proxy": false, "alerts": true,
  "sessions": { "total": 42, "connected": 41, "down": 1, "terminal": 0 } }
GET/health/clients

Per-session state

No auth. Connection state, reconnect count and last disconnect reason for every session on the responding node.

No parameters

Response · 200
{ "podName": "node-0", "failedCount": 1, "clients": [
  { "clientId": "acmemain", "jid": "60123456789:[email protected]", "status": "connected", "connected": true, "loggedIn": true, "enableGroupAi": false, "reconnects": 2, "connectedAt": "2026-08-28T05:34:05Z", "lastDisconnect": "" } ] }
GET/config

Runtime configuration

Non-secret build/runtime facts and the route inventory of the deployed version.

No parameters

Response · 200
{ "podName": "node-0", "environment": "production", "storage": true, "publicMedia": true, "proxy": false, "alerts": true, "version": "2026-08", "routes": ["POST /start", "GET /qr", "…"] }