Skip to main content
GET
Service liveness
Unauthenticated. Useful if you want your own monitoring to watch the API.
There is also GET /health/ready, which additionally confirms the API can reach its data store. It answers 200 with {"status":"ok","database":"reachable"}, or 503 with {"status":"degraded","database":"unreachable"}.
Neither endpoint tells you anything about your numbers. A healthy API with a disconnected WhatsApp number will still return 200 here and 409 instance_not_connected on a send. To monitor your numbers, poll GET /v1/instances and watch the connected flag.

Response

200 - application/json

The service is up.

status
string
service
string