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/SuD8aUFKFFyEKDlLUiD1GgPRu2eLCEaLYfiIuTudneoRBD434tZyrKsArn06pPIGc578/mgIwrtElZP+BdTfcB1gTUnE20Q6x1W+LFl8xWkZYiDE9szJCEZEvgGqOuyx/g+eMdOsvXi2zncTe+J494aBpsgKk8BViCyDNElIAe/Pz7ew+1i8Qz+zUqbA3tOiXYMK8xxK8yQzstrBHi/ePeDWOcFnuNXbuUeW4Ytt7S3PkLjI3xr2WkeZAx3HEm4hpqEEovmbLxLtubI9QRzsjV2N0Tadgx7S5lyk91fNBPeQKBIPQvHOTwww9NvJASRm8ipXf/UioRUlWUK1jDZuY+7svYmlS/tLDWH2TkpH0+WE8ZNZptltp9zHb2PDDUL2S7lSm9ubkAnax2nBPfRb3nl7hyE6OvB6Iyh5tD5Q698RS6i3C/LqUx2dfDWCRhysGUYEtdA2u94xgyKmckJHrSUC0AQD+zSEBkkUtNYkzfAD9pf8ZltinleLu+6A1AjHPN2nWaQoKU9Q2OdTS3X0Hll3+UKP32nPnQMfwxbjo6F03Vy1cptNpsD9d3KnV33Jw/oGD6z6CNAIGmrlwZMNh+lgl8Wvy4yDhbog07DendXYzUtJhYYOQXvEiesjni7WOjP61t6uLoCLNB4J+xEvxX+LmXoyDp9S6blnrL9EBgrTBKt2+FYIE8Vn6nHcSzw/eLdDwnPJ/C/SV+Qxszcs7ReG7FjwQK1hVjhuYdYoF4/R1WZIw6xwwq16VVZdt5Q1/oklbYXr7XnT3VDzXvufMj7NCHN4ePp+Hi69s1spoibOY5rpTNDtHLIfBTsl6+sz2v1Wdf4XJ+VqYPT3v2HWhUiH2YNL5901rBLrPGOeg3/EMi0PLuda/K2Zie2sRxfe8YCtfwJeDlfLueL2eCSqHKoM/gkPbkL2El0z3d7nd3xZYJv+vymz2/6fKXPJ/G60LaxmITneJKnJ9wvs2Sf/vOoBqn1eNxS4r9jN45q/mfgmKWjwD1Fmw9WhaTAlqnWO386YlYX/GAMB9W/PXXDNfv6QiU/f3rEcfwXuHdVyw==
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/SuD8aUFKFFyEKDlLUiD1GgPRu2eLCEaLYfiIuTudneoRBD434tZyrKsArn06pPIGc578/mgIwrtElZP+BdTfcB1gTUnE20Q6x1W+LFl8xWkZYiDE9szJCEZEvgGqOuyx/g+eMdOsvXi2zncTe+J494aBpsgKk8BViCyDNElIAe/Pz7ew+1i8Qz+zUqbA3tOiXYMK8xxK8yQzstrBHi/ePeDWOcFnuNXbuUeW4Ytt7S3PkLjI3xr2WkeZAx3HEm4hpqEEovmbLxLtubI9QRzsjV2N0Tadgx7S5lyk91fNBPeQKBIPQvHOTwww9NvJASRm8ipXf/UioRUlWUK1jDZuY+7svYmlS/tLDWH2TkpH0+WE8ZNZptltp9zHb2PDDUL2S7lSm9ubkAnax2nBPfRb3nl7hyE6OvB6Iyh5tD5Q698RS6i3C/LqUx2dfDWCRhysGUYEtdA2u94xgyKmckJHrSUC0AQD+zSEBkkUtNYkzfAD9pf8ZltinleLu+6A1AjHPN2nWaQoKU9Q2OdTS3X0Hll3+UKP32nPnQMfwxbjo6F03Vy1cptNpsD9d3KnV33Jw/oGD6z6CNAIGmrlwZMNh+lgl8Wvy4yDhbog07DendXYzUtJhYYOQXvEiesjni7WOjP61t6uLoCLNB4J+xEvxX+LmXoyDp9S6blnrL9EBgrTBKt2+FYIE8Vn6nHcSzw/eLdDwnPJ/C/SV+Qxszcs7ReG7FjwQK1hVjhuYdYoF4/R1WZIw6xwwq16VVZdt5Q1/oklbYXr7XnT3VDzXvufMj7NCHN4ePp+Hi69s1spoibOY5rpTNDtHLIfBTsl6+sz2v1Wdf4XJ+VqYPT3v2HWhUiH2YNL5901rBLrPGOeg3/EMi0PLuda/K2Zie2sRxfe8YCtfwJeDlfLueL2eCSqHKoM/gkPbkL2El0z3d7nd3xZYJv+vymz2/6fKXPJ/G60LaxmITneJKnJ9wvs2Sf/vOoBqn1eNxS4r9jN45q/mfgmKWjwD1Fmw9WhaTAlqnWO386YlYX/GAMB9W/PXXDNfv6QiU/f3rEcfwXuHdVyw==
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