Ready

Check whether the cluster is ready to serve requests.

GET/ready

Public endpointNo API key required.

Returns 503 when a required dependency or configuration is unavailable, or writes are paused.

Request

https://engine.example.com/ready

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

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

200

The cluster is ready.

{
  "status": "ok"
}

The cluster is ready.

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.

A dependency, cluster readiness condition, or capacity limit prevents this operation.

What to do: Inspect retryable and details. Retry only when permitted, preserving the idempotency key for the same write.

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?