Check node health

Check for node health. If ready is true, also check if this node is fully operational and ready to accept SQL connections. Otherwise, this endpoint always returns a successful response (if the API server is up).

GET /health/

cURL

cURL

curl --request GET \
  --url https://localhost/api/v2/health/

Query Parameters

ready · boolean

If true, check whether this node is ready to accept SQL connections. If false, this endpoint always returns success, unless the API server itself is down.

Response

200

Indicates healthy node.