---
title: "Check Readiness"
method: GET
path: "/v1/ready"
tags: ["Ready"]
---

# 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](https://spiceai.org/docs/components/data-accelerators/data-refresh#ready-state) 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 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:
```yaml
readinessProbe:
 httpGet:
   path: /v1/ready
   port: 8090
```

Example with executor gating (scheduler role):
```yaml
readinessProbe:
 httpGet:
   path: /v1/ready?min_ready_executors=3&min_ready_executors_percent=80
   port: 8090
```

## Query parameters

- `min_ready_executors` integer, nullable
- `min_ready_executors_percent` integer, nullable
- `verbose` boolean

## Response `200`

Service is ready

## Other responses

- `400` — Invalid query parameter or executor gate requested outside scheduler role
- `503` — Service is not ready

## Changes

> 53 revisions in range; 26 could not be searched.

- **2025-03-18** `dd94571fef79` — 3 warning, 1 info
  - deleted the `query` request parameter `min_ready_executors`
  - deleted the `query` request parameter `min_ready_executors_percent`
  - deleted the `query` request parameter `verbose`
  - removed the non-success response with the status `400`

[Change history](https://skmtc.dev/spiceai/apis/runtime/changes/v1/ready/get.md)

---

[API](https://skmtc.dev/spiceai/apis/runtime.md) · [All operations](https://skmtc.dev/spiceai/apis/runtime/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/spiceai/runtime/revisions/fb597a4eaa56/schema)
