Skip to main content
Version: Next

Check Readiness

GET 
/v1/ready

Check the runtime status of all the components of the runtime. If the service is ready, it returns an HTTP 200 status with the message "ready". If not, it returns a 503 status with the message "not ready".

The behavior for when an accelerated dataset is considered ready is configurable via the ready_state parameter. See Data refresh for more details.

In distributed (scheduler) mode the readiness response can additionally be gated on executor availability via the min_ready_executors and min_ready_executors_percent query parameters (both optional). Both gates must pass when supplied. Pass verbose=true to get a multi-line diagnostic body explaining each gate.

Readiness Probe​

In production deployments, the /v1/ready endpoint can be used as a readiness probe for a Spice deployment to ensure traffic is routed to the Spice runtime only after all datasets have finished loading.

Example Kubernetes readiness probe:

readinessProbe:
 httpGet:
   path: /v1/ready
   port: 8090

Example with executor gating (scheduler role):

readinessProbe:
 httpGet:
   path: /v1/ready?min_ready_executors=3&min_ready_executors_percent=80
   port: 8090

Request​

Responses​

Service is ready