1---
2id: get-spicepods
3title: "List Spicepods"
4description: "Get a list of spicepods and their summary details."
5sidebar_label: "List Spicepods"
6hide_title: true
7hide_table_of_contents: true
8api: eJytVU1v2zgQ/SvEXNIFGH+lAVrdisU2KNDDAumeskZKS2OLLUWy5EjbQNB/XwylWLKtokXQkw0N+d6bNx9sgdQhQvYAd2gxKANbCQXGPGhP2lnI4A5JKGF0JOH2Inqdo3dFFMoWgkrUQcS6qlR4EgWS0iYuQILzGBQDfCgggwPS4/EiSPAqqAoJAzO3YFWFkMHehUoRSNBM+63G8ATnYj6VKPpzLIZKFAGjdzbiQvztYtQ7g6JRpsYoVEBx9SU6eyVeFbhXtaE/hAviKo/NFYsM+K3WAQvI9spElBDzEisFWQv05FlSpKDtASSgrSt2ieFAQh4bNoo0GT72vlfedVsG7fVEhtmsVvxzmsPHcysZ0FlCS3xYeW90nsxbJrqsvRSmQlDsjias4uS7233BnE5ye+j9ldBgiKxgK8EHLhDpXmWhSEWk+Ji7utcwoGlLeMAwWwVbVzsMnMfzdaGtoFLHY2IgodJWV2zdqmMQj7ZAm2t8MdcE4qd8lSvQvJSpv/xTjr53LxtmBlpV+Ny0R7RuLMsvgQyHL3G6sRvvh4/3/VimGH5XlefoOG7Pd9eT1sigWS9WixVznzXFzbmfm/mC3nbygmJzSrH5AcXrc4qbeYpNt+V08TsteRDn5mOwcJp5EiUHGfKUW0555SXnv/boluwdkjdyI2/H7xvZpyVfcwQ6Nv12bvo/WMJglRERQ4NBYAgunG6AlJk3Ss/P/lxu86hdklEhlW5Yw2n5UgkZLJv1crqB+ov9Qq6DgQxKIp8tl8blypQuUvZm9XZ10ZUfOSwKbNA4X6GlQcJC/OnsXh/qgOI/TaX4fH3NiJ8XwGsyYl4HTU+JT3n9+BX5/5Zj2u5dyndo6FBb0mmFXQ5ESqEQ4xGjc7QxzeTQhe+8yku83qSe0wVa0nuN4TQyHURYL9brxeq6tpHUziAHvYtUKTuBTWv8fuLgibh2LOjLXtCh2JNe6GRfmHYo4QM0PLtjEbcSuE4cadudivhPMF3Hn/vHlK0udOSUxjfvh6p/61M7m00q+fjsJyzIIPVHo4JO3nNPSChRFVyyh3a49S7P0U9vXTybjHJs/bu/PkHX/Q99RRND
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={"List Spicepods"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"get"}
32 path={"/v1/spicepods"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40Get a list of spicepods and their summary details.
41
42<Heading
43 id={"request"}
44 as={"h2"}
45 className={"openapi-tabs__heading"}
46 children={"Request"}
47>
48</Heading>
49
50<ParamsDetails
51 parameters={[{"name":"format","in":"query","description":"The format of the response. Possible values are 'json' (default) or 'csv'.","required":false,"schema":{"type":"string","enum":["json","csv"],"title":"Format"}}]}
52>
53
54</ParamsDetails>
55
56<RequestSchema
57 title={"Body"}
58 body={undefined}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 id={undefined}
65 label={undefined}
66 responses={{"200":{"description":"List of spicepods","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","version"],"properties":{"datasets_count":{"type":"integer","description":"The number of datasets in this spicepod","minimum":0},"dependencies_count":{"type":"integer","description":"The number of dependencies in this spicepod","minimum":0},"models_count":{"type":"integer","description":"The number of models in this spicepod","minimum":0},"name":{"type":"string","description":"The name of the spicepod"},"version":{"type":"string","description":"The version of the spicepod"}},"title":"SpicepodSummary"}},"example":[{"name":"spicepod1","version":"v1.0.0","datasets_count":3,"models_count":2,"dependencies_count":5},{"name":"spicepod2","version":"v2.0.0","datasets_count":4,"models_count":3,"dependencies_count":2}]},"text/csv":{"schema":{"type":"string"},"example":"name,version,datasets_count,models_count,dependencies_count\nspicepod1,v1.0.0,3,2,5\nspicepod2,v2.0.0,4,3,2"}}},"500":{"description":"Internal server error","content":{"text/plain":{"schema":{"type":"string"},"example":"Internal server error"}}}}}
67>
68
69</StatusCodes>
70
71
72
1---
2id: get-spicepods
3title: "List Spicepods"
4description: "Get a list of spicepods and their summary details."
5sidebar_label: "List Spicepods"
6hide_title: true
7hide_table_of_contents: true
8api: eJytVU1v2zgQ/SvEXNIFGH+lAVrdisU2KNDDAumeskZKS2OLLUWy5EjbQNB/XwylWLKtokXQkw0N+d6bNx9sgdQhQvYAd2gxKANbCQXGPGhP2lnI4A5JKGF0JOH2Inqdo3dFFMoWgkrUQcS6qlR4EgWS0iYuQILzGBQDfCgggwPS4/EiSPAqqAoJAzO3YFWFkMHehUoRSNBM+63G8ATnYj6VKPpzLIZKFAGjdzbiQvztYtQ7g6JRpsYoVEBx9SU6eyVeFbhXtaE/hAviKo/NFYsM+K3WAQvI9spElBDzEisFWQv05FlSpKDtASSgrSt2ieFAQh4bNoo0GT72vlfedVsG7fVEhtmsVvxzmsPHcysZ0FlCS3xYeW90nsxbJrqsvRSmQlDsjias4uS7233BnE5ye+j9ldBgiKxgK8EHLhDpXmWhSEWk+Ji7utcwoGlLeMAwWwVbVzsMnMfzdaGtoFLHY2IgodJWV2zdqmMQj7ZAm2t8MdcE4qd8lSvQvJSpv/xTjr53LxtmBlpV+Ny0R7RuLMsvgQyHL3G6sRvvh4/3/VimGH5XlefoOG7Pd9eT1sigWS9WixVznzXFzbmfm/mC3nbygmJzSrH5AcXrc4qbeYpNt+V08TsteRDn5mOwcJp5EiUHGfKUW0555SXnv/boluwdkjdyI2/H7xvZpyVfcwQ6Nv12bvo/WMJglRERQ4NBYAgunG6AlJk3Ss/P/lxu86hdklEhlW5Yw2n5UgkZLJv1crqB+ov9Qq6DgQxKIp8tl8blypQuUvZm9XZ10ZUfOSwKbNA4X6GlQcJC/OnsXh/qgOI/TaX4fH3NiJ8XwGsyYl4HTU+JT3n9+BX5/5Zj2u5dyndo6FBb0mmFXQ5ESqEQ4xGjc7QxzeTQhe+8yku83qSe0wVa0nuN4TQyHURYL9brxeq6tpHUziAHvYtUKTuBTWv8fuLgibh2LOjLXtCh2JNe6GRfmHYo4QM0PLtjEbcSuE4cadudivhPMF3Hn/vHlK0udOSUxjfvh6p/61M7m00q+fjsJyzIIPVHo4JO3nNPSChRFVyyh3a49S7P0U9vXTybjHJs/bu/PkHX/Q99RRND
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={"List Spicepods"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"get"}
32 path={"/v1/spicepods"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40Get a list of spicepods and their summary details.
41
42<Heading
43 id={"request"}
44 as={"h2"}
45 className={"openapi-tabs__heading"}
46 children={"Request"}
47>
48</Heading>
49
50<ParamsDetails
51 parameters={[{"name":"format","in":"query","description":"The format of the response. Possible values are 'json' (default) or 'csv'.","required":false,"schema":{"type":"string","enum":["json","csv"],"title":"Format"}}]}
52>
53
54</ParamsDetails>
55
56<RequestSchema
57 title={"Body"}
58 body={undefined}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 id={undefined}
65 label={undefined}
66 responses={{"200":{"description":"List of spicepods","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","version"],"properties":{"datasets_count":{"type":"integer","description":"The number of datasets in this spicepod","minimum":0},"dependencies_count":{"type":"integer","description":"The number of dependencies in this spicepod","minimum":0},"models_count":{"type":"integer","description":"The number of models in this spicepod","minimum":0},"name":{"type":"string","description":"The name of the spicepod"},"version":{"type":"string","description":"The version of the spicepod"}},"title":"SpicepodSummary"}},"example":[{"name":"spicepod1","version":"v1.0.0","datasets_count":3,"models_count":2,"dependencies_count":5},{"name":"spicepod2","version":"v2.0.0","datasets_count":4,"models_count":3,"dependencies_count":2}]},"text/csv":{"schema":{"type":"string"},"example":"name,version,datasets_count,models_count,dependencies_count\nspicepod1,v1.0.0,3,2,5\nspicepod2,v2.0.0,4,3,2"}}},"500":{"description":"Internal server error","content":{"text/plain":{"schema":{"type":"string"},"example":"Internal server error"}}}}}
67>
68
69</StatusCodes>
70
71
72