Health

Check whether the cluster process is alive.

GET/health

Public endpointNo API key required.

A successful health response does not establish that storage is ready. Use the readiness endpoint before admitting traffic.

Request

https://engine.example.com/health

GET /health HTTP/1.1
Host: engine.example.com

Replace engine.example.com with your cluster host. This request does not require a key.

200

The process is alive.

{
  "status": "ok"
}

The process is alive.

application/json

The Engine request ID. Retain it when investigating a failed or unexpected request.

x-request-idstringrequired

The X-Request-Id you sent, echoed when it is a valid ID. Otherwise, the Engine request ID.

status"ok"optional

ok means this health or readiness check succeeded.

Default: "ok"

Select an error in the response example to see its JSON body. See error handling for the common error format.

An unexpected server failure prevented this request from completing.

What to do: Retain request_id for investigation. Follow retryable before retrying a write.

Was this page helpful?