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/SuD8SUFKFF2kKLlLUiD1GgPRu2eLCEaLYfiIuTudneoRBD434NZyrKsArnk6pPIGc578/mgAwptE1aP+A9TvcdVgTUnE20Q6x1W+KFl8wWkZYiDE9szJCEZEvgGqOuyx/g+eMdOsvXs2zncTu+J484aBpsgKk8BViCyDNElIAd/Pjzcwc1i8QT+1UqbA3tOibYMS8xxS8yQzstLBHi3ePuDWOcFnuKXbukeWoYNt7SzPkLjI3xt2WkeZAx3HEm4hpqEEovmbLxLtubI9QRztDV2O0TadAw7S5lynd2fNRNeQ6BIPQvHOdwzw+MfJASRm8ipXb1pRUKqyjIFa5js3MdtWXuTyud2lprD7JSUj0fLEeMqs80y2y+5jt5HhpqFbJdypVdXV6CTtY5TgrvoN7x0tw5C9PVgdMZQc+j8vle+IhdR7q7LqUx2dfDWCRhysGEYEtdA2u94wgyKmckJ7rWUM0AQD+zSEBkkUtNYkzfAD9pf8ZltinlaLu+6PVAjHPN2HWeQoKUdQ2OdTS3X0Hll3+YKP36jPnQMfw0bjo6F02Vy1dKt1+s99d3SnVx3Rw/oGD6x6CNAIGmr5wZMNh+lgt8Wvy8yDhbog07DendbYzUtJhYYOQXvEiesDnizWOjPy1u6v7gCLNB4J+xEvxX+JmXoyDp9S6blnrJ9HxgrTBKt2+JYIE8Vn6jHcSzw3eLtDwlPJ/DTpM9IY2buWVqvjdiyYIHaQqzw1EMsUK+fo6rMAYfYYYXa9KosO2+oa32SStuLl9rzt7qh5h13PuR9mpDm8OF4fDxd+3o2U8T1HMeV0pkhWtlnPgr28xfW55X6rGt8rs/K1MFp7/5HrQqRD7OG5086a9gl1nhHvYa/D2Rant3MNXlbsxPbWI4vPWOBWv4EfD3/db6YDS6JCof6gk/SkztDnTT3dLaXyR2eB/gqz6/y/CrPF/J81K4zaRuLSXcOR3V6xN11VuzjXx6VILUeDhtK/G/sxlHN/w0cs3IUuKNo88GqjhTYMtV65o8HzOKC743hoPK3o264ZF+dieSnjw84jt8BHetVnw==
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/SuD8SUFKFF2kKLlLUiD1GgPRu2eLCEaLYfiIuTudneoRBD434NZyrKsArnk6pPIGc578/mgAwptE1aP+A9TvcdVgTUnE20Q6x1W+KFl8wWkZYiDE9szJCEZEvgGqOuyx/g+eMdOsvXs2zncTu+J484aBpsgKk8BViCyDNElIAd/Pjzcwc1i8QT+1UqbA3tOibYMS8xxS8yQzstLBHi3ePuDWOcFnuKXbukeWoYNt7SzPkLjI3xt2WkeZAx3HEm4hpqEEovmbLxLtubI9QRztDV2O0TadAw7S5lynd2fNRNeQ6BIPQvHOdwzw+MfJASRm8ipXb1pRUKqyjIFa5js3MdtWXuTyud2lprD7JSUj0fLEeMqs80y2y+5jt5HhpqFbJdypVdXV6CTtY5TgrvoN7x0tw5C9PVgdMZQc+j8vle+IhdR7q7LqUx2dfDWCRhysGEYEtdA2u94wgyKmckJ7rWUM0AQD+zSEBkkUtNYkzfAD9pf8ZltinlaLu+6PVAjHPN2HWeQoKUdQ2OdTS3X0Hll3+YKP36jPnQMfw0bjo6F02Vy1dKt1+s99d3SnVx3Rw/oGD6x6CNAIGmr5wZMNh+lgt8Wvy8yDhbog07DendbYzUtJhYYOQXvEiesDnizWOjPy1u6v7gCLNB4J+xEvxX+JmXoyDp9S6blnrJ9HxgrTBKt2+JYIE8Vn6jHcSzw3eLtDwlPJ/DTpM9IY2buWVqvjdiyYIHaQqzw1EMsUK+fo6rMAYfYYYXa9KosO2+oa32SStuLl9rzt7qh5h13PuR9mpDm8OF4fDxd+3o2U8T1HMeV0pkhWtlnPgr28xfW55X6rGt8rs/K1MFp7/5HrQqRD7OG5086a9gl1nhHvYa/D2Rant3MNXlbsxPbWI4vPWOBWv4EfD3/db6YDS6JCof6gk/SkztDnTT3dLaXyR2eB/gqz6/y/CrPF/J81K4zaRuLSXcOR3V6xN11VuzjXx6VILUeDhtK/G/sxlHN/w0cs3IUuKNo88GqjhTYMtV65o8HzOKC743hoPK3o264ZF+dieSnjw84jt8BHetVnw==
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