1---
2id: ready
3title: "Check Readiness"
4description: "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'."
5sidebar_label: "Check Readiness"
6hide_title: true
7hide_table_of_contents: true
8api: eJztVk1v20YQ/SuD8aUFaFF2EKDhLUiCxGgPRu2eLCEaLYfiIuTudneoRBD434tZypKsALn06pPIGc578/mgPQptElZP+DdTvcNlgTUnE20Q6x1W+KFl8w2kZYiDE9szJCEZEvgGqOuyx/g+eMdOsvXs2xncTe+J49YaBpsgKk8BViCyDNElIAdfHh/v4XY+fwb/bqXNgT2nRBuGBea4BWZI5+UlArydv/lFrPMCz/ELt3CPLcOaW9paH6HxEb637DQPMoY7jiRcQ01CiUVzNt4lW3PkeoI52Bq7GSKtO4atpUy5yu6vmgmvIFCknoXjDB6Y4ekjCUHkJnJql7+1IiFVZZmCNUx25uOmrL1J5amdpeZwfUzKx4PlgHGV2a4z2++5jt5HhpqFbJdypVdXV6CTtY5Tgvvo17xwdw5C9PVgdMZQc+j8rle+IhdRbm/KqUx2dfDWCRhysGYYEtdA2u94xAyKmckJHrSUM0AQD+zSEBkkUtNYkzfAD9pf8ZltinleLu+6HVAjHPN2HWaQoKUtQ2OdTS3X0Hll3+QKP/2gPnQMfw5rjo6F02Vy1cKtVqsd9d3CHV33Bw/oGD6z6CNAIGmrUwMmm49SwR/zd/OMgwX6oNOw3t3VWE2LiQVGTsG7xAmrPd7O5/rz8pYeLq4ACzTeCTvRb4V/SBk6sk7fkmm5p2zfBcYKk0TrNjgWyFPFR+pxHAt8O3/zS8LjCfxv0hPSmJl7ltZrIzYsWKC2ECs89hAL1OvnqCqzxyF2WKE2vSrLzhvqWp+k0vbipfb8pW6oecudD3mfJqQZfDgcH0/Xvrq+VsTVDMel0pkhWtllPgr26zfW56X6rGt8rs/K1MFp736iVoXIh1nD6ZPOGnaJNd5Rr+HvA5mWr29nmryt2YltLMeXnrFALX8Cvpm9m92qKfgkPbkzsElqj9d6mdP+NLdXVX5V5VdVvlDlg2SdKdpYTHKzP4jSE25vslAf/umo8qh1v19T4n9iN45q/nfgmAWjwC1Fq6uU5aPAlqnW637aY9YUfG8MB1W9LXXDJfvyTBs/f3rEcfwP1AFSGQ==
9sidebar_class_name: "get api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24  as={"h1"}
25  className={"openapi__heading"}
26  children={"Check Readiness"}
27>
28</Heading>
29
30<MethodEndpoint
31  method={"get"}
32  path={"/v1/ready"}
33  context={"endpoint"}
34>
35  
36</MethodEndpoint>
37
38
39
40Check 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".
41
42The 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.
43
44### Readiness Probe
45In 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.
46
47Example Kubernetes readiness probe:
48```yaml
49readinessProbe:
50 httpGet:
51   path: /v1/ready
52   port: 8090
53```
54
55<ParamsDetails
56  parameters={undefined}
57>
58  
59</ParamsDetails>
60
61<RequestSchema
62  title={"Body"}
63  body={undefined}
64>
65  
66</RequestSchema>
67
68<StatusCodes
69  id={undefined}
70  label={undefined}
71  responses={{"200":{"description":"Service is ready","content":{"text/plain":{"schema":{"type":"string"},"example":"ready"}}},"503":{"description":"Service is not ready","content":{"text/plain":{"schema":{"type":"string"},"example":"not ready"}}}}}
72>
73  
74</StatusCodes>
75
76
77      

1---
2id: ready
3title: "Check Readiness"
4description: "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'."
5sidebar_label: "Check Readiness"
6hide_title: true
7hide_table_of_contents: true
8api: eJztVk1v20YQ/SuD8aUFaFF2EKDhLUiCxGgPRu2eLCEaLYfiIuTudneoRBD434tZypKsALn06pPIGc578/mgPQptElZP+DdTvcNlgTUnE20Q6x1W+KFl8w2kZYiDE9szJCEZEvgGqOuyx/g+eMdOsvXs2xncTe+J49YaBpsgKk8BViCyDNElIAdfHh/v4XY+fwb/bqXNgT2nRBuGBea4BWZI5+UlArydv/lFrPMCz/ELt3CPLcOaW9paH6HxEb637DQPMoY7jiRcQ01CiUVzNt4lW3PkeoI52Bq7GSKtO4atpUy5yu6vmgmvIFCknoXjDB6Y4ekjCUHkJnJql7+1IiFVZZmCNUx25uOmrL1J5amdpeZwfUzKx4PlgHGV2a4z2++5jt5HhpqFbJdypVdXV6CTtY5Tgvvo17xwdw5C9PVgdMZQc+j8rle+IhdRbm/KqUx2dfDWCRhysGYYEtdA2u94xAyKmckJHrSUM0AQD+zSEBkkUtNYkzfAD9pf8ZltinleLu+6HVAjHPN2HWaQoKUtQ2OdTS3X0Hll3+QKP/2gPnQMfw5rjo6F02Vy1cKtVqsd9d3CHV33Bw/oGD6z6CNAIGmrUwMmm49SwR/zd/OMgwX6oNOw3t3VWE2LiQVGTsG7xAmrPd7O5/rz8pYeLq4ACzTeCTvRb4V/SBk6sk7fkmm5p2zfBcYKk0TrNjgWyFPFR+pxHAt8O3/zS8LjCfxv0hPSmJl7ltZrIzYsWKC2ECs89hAL1OvnqCqzxyF2WKE2vSrLzhvqWp+k0vbipfb8pW6oecudD3mfJqQZfDgcH0/Xvrq+VsTVDMel0pkhWtllPgr26zfW56X6rGt8rs/K1MFp736iVoXIh1nD6ZPOGnaJNd5Rr+HvA5mWr29nmryt2YltLMeXnrFALX8Cvpm9m92qKfgkPbkzsElqj9d6mdP+NLdXVX5V5VdVvlDlg2SdKdpYTHKzP4jSE25vslAf/umo8qh1v19T4n9iN45q/nfgmAWjwC1Fq6uU5aPAlqnW637aY9YUfG8MB1W9LXXDJfvyTBs/f3rEcfwP1AFSGQ==
9sidebar_class_name: "get api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24  as={"h1"}
25  className={"openapi__heading"}
26  children={"Check Readiness"}
27>
28</Heading>
29
30<MethodEndpoint
31  method={"get"}
32  path={"/v1/ready"}
33  context={"endpoint"}
34>
35  
36</MethodEndpoint>
37
38
39
40Check 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".
41
42The 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.
43
44### Readiness Probe
45In 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.
46
47Example Kubernetes readiness probe:
48```yaml
49readinessProbe:
50 httpGet:
51   path: /v1/ready
52   port: 8090
53```
54
55<ParamsDetails
56  parameters={undefined}
57>
58  
59</ParamsDetails>
60
61<RequestSchema
62  title={"Body"}
63  body={undefined}
64>
65  
66</RequestSchema>
67
68<StatusCodes
69  id={undefined}
70  label={undefined}
71  responses={{"200":{"description":"Service is ready","content":{"text/plain":{"schema":{"type":"string"},"example":"ready"}}},"503":{"description":"Service is not ready","content":{"text/plain":{"schema":{"type":"string"},"example":"not ready"}}}}}
72>
73  
74</StatusCodes>
75
76
77