1---
2id: get-status
3title: "Check Runtime Status"
4description: "Return the status of all connections (http, flight, metrics, opentelemetry) in the runtime."
5sidebar_label: "Check Runtime Status"
6hide_title: true
7hide_table_of_contents: true
8api: eJy1VlFv2zgM/isCn1ZAdZLeDuv8VrS7oUAxHNruXupgU20m1mZLnkRnywL/9wMlO7EvKXYPd09xJOoj+X0kpR2QWntIn+A9GnSqgqWEAn3udEPaGkjhHql1RlCJwpOi1gu7EqqqRG6NwZytvHhVEjVSrCq9LkmKGsnp3EthGzSEFfLC9kzoiONaQ7rGBCTYBp1ijNsCUlgjfYpOQEKjnKqR0HF8OzCqRkhhZV2tCCRoDu5bi24L/wz5sUQR7TjW4BF9Y41HKVBTiU5k8MVbk4Gw/J37TQaJuMGVaivyguzegIN0+K3VDgtIV6ryKMHnJdYK0h3QtuGoPDlt1iABTVsznXwYJAMzo6SpYrM/YvBdt2TQGJJnmIv5nH+madxpHxI4EN0rgExPbg2hIT6mmqbSeaBxFhynu+MQlXOKqdKEtR+t2+cvmNMky6dINmdTNFYb3u1lWUpoHItGOka+NzlBxrEqg/Wgyyi1V5isEyk+3t+xJrd/ClUUDr0/g0724v8bD2z5MnoGXKgZ8Fcs1vjdF2z8MynaDEIAffpHGj1O2iI6rRtr0NDg8x5VsZXi1mjSqtI/tVlLcaO9eq6wkOKdc9ZJgZQnZyBfLKjxcZAQQEHCgAMSAlDYWjn0ZbR7KFsibdY39rsZV+L1EOVDTKzrxnsDbTdISldxF3+ouuH9Qy8yl+MqiSvpbLa4eJPMk3mySC/nl/ND9aR93J089HNQ4Rcob+fzCcqEjBFYL+MU7cPsanx2z9jo3ETxX8Ty+rfFmzFepL1bMoH4g2bc8qf6r1d0zGRwLwdnMkJmJszSk0zKQF9m+jl7kic5Jiczwyj+MLuSQ+qZmSR8jMM5yj4x1v73U+Mp7HOPbXgamDVPzeuHv6ajKVDSVEqfHkqnSHkJtwuh1Eil7e+KcElQCSnMNovZ/uLw6DbDrdG66iBiZXNVldZTejl/Oz8aH3e8LQrcYGWbmjs4IiXi2pqVXrcOxXdNpfh8fs6InxPgQe4xb52mbfCnGv3pK/L3kve0WdmQbt9a/c13cnL5RudYiINJpXM0Psy9vk6vGpWXeH6RcPC6QEN6pdFNdzoJnH4EXiSv41JjPdXKjMCuS8y/ivvoTjwM7E0C2x20/J8fAn1BjOqlk1G9XS/yE2wWk4uIleTl3e5Zefzoqq7j5fgmYDGKodWHe/vF3P7rF8PJbEJdHB4wG1W1bBSKaKOc5lhD4UgoURWs69OuP3WV59iMTx3d+Yyyb4737x6h6/4GqbdUfg==
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 Runtime Status"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"get"}
32 path={"/v1/status"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40Return the status of all connections (http, flight, metrics, opentelemetry) in the runtime.
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, either \"json\" or \"csv\". Defaults to \"json\".","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 connection statuses","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","endpoint","status"],"properties":{"endpoint":{"type":"string","description":"The endpoint of the connection (e.g., URL or IP address)"},"name":{"type":"string","description":"The name of the connection (e.g., \"http\", \"flight\", \"metrics\", \"opentelemetry\")"},"status":{"description":"The status of the component (e.g., Ready, Initializing, Disabled, Error, etc.)","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}},"title":"ConnectionDetails"}},"example":[{"name":"http","endpoint":"http://127.0.0.1:8080","status":"Ready"},{"name":"flight","endpoint":"http://127.0.0.1:9000","status":"Initializing"},{"name":"metrics","endpoint":"N/A","status":"Disabled"},{"name":"opentelemetry","endpoint":"http://127.0.0.1:4317","status":"Error"}]},"text/csv":{"schema":{"type":"string"},"example":"name,endpoint,status\nhttp,http://127.0.0.1:8080,Ready\nflight,http://127.0.0.1:9000,Initializing\nmetrics,N/A,Disabled\nopentelemetry,http://127.0.0.1:4317,Error"}}},"500":{"description":"Error converting to CSV","content":{"text/plain":{"schema":{"type":"string"},"example":"Error converting to CSV"}}}}}
67>
68
69</StatusCodes>
70
71
72
1---
2id: get-status
3title: "Check Runtime Status"
4description: "Return the status of all connections (http, flight, metrics, opentelemetry) in the runtime."
5sidebar_label: "Check Runtime Status"
6hide_title: true
7hide_table_of_contents: true
8api: eJy1VlFv2zgM/isCn1ZAdZLeDuv8VrS7oUAxHNruXupgU20m1mZLnkRnywL/9wMlO7EvKXYPd09xJOoj+X0kpR2QWntIn+A9GnSqgqWEAn3udEPaGkjhHql1RlCJwpOi1gu7EqqqRG6NwZytvHhVEjVSrCq9LkmKGsnp3EthGzSEFfLC9kzoiONaQ7rGBCTYBp1ijNsCUlgjfYpOQEKjnKqR0HF8OzCqRkhhZV2tCCRoDu5bi24L/wz5sUQR7TjW4BF9Y41HKVBTiU5k8MVbk4Gw/J37TQaJuMGVaivyguzegIN0+K3VDgtIV6ryKMHnJdYK0h3QtuGoPDlt1iABTVsznXwYJAMzo6SpYrM/YvBdt2TQGJJnmIv5nH+madxpHxI4EN0rgExPbg2hIT6mmqbSeaBxFhynu+MQlXOKqdKEtR+t2+cvmNMky6dINmdTNFYb3u1lWUpoHItGOka+NzlBxrEqg/Wgyyi1V5isEyk+3t+xJrd/ClUUDr0/g0724v8bD2z5MnoGXKgZ8Fcs1vjdF2z8MynaDEIAffpHGj1O2iI6rRtr0NDg8x5VsZXi1mjSqtI/tVlLcaO9eq6wkOKdc9ZJgZQnZyBfLKjxcZAQQEHCgAMSAlDYWjn0ZbR7KFsibdY39rsZV+L1EOVDTKzrxnsDbTdISldxF3+ouuH9Qy8yl+MqiSvpbLa4eJPMk3mySC/nl/ND9aR93J089HNQ4Rcob+fzCcqEjBFYL+MU7cPsanx2z9jo3ETxX8Ty+rfFmzFepL1bMoH4g2bc8qf6r1d0zGRwLwdnMkJmJszSk0zKQF9m+jl7kic5Jiczwyj+MLuSQ+qZmSR8jMM5yj4x1v73U+Mp7HOPbXgamDVPzeuHv6ajKVDSVEqfHkqnSHkJtwuh1Eil7e+KcElQCSnMNovZ/uLw6DbDrdG66iBiZXNVldZTejl/Oz8aH3e8LQrcYGWbmjs4IiXi2pqVXrcOxXdNpfh8fs6InxPgQe4xb52mbfCnGv3pK/L3kve0WdmQbt9a/c13cnL5RudYiINJpXM0Psy9vk6vGpWXeH6RcPC6QEN6pdFNdzoJnH4EXiSv41JjPdXKjMCuS8y/ivvoTjwM7E0C2x20/J8fAn1BjOqlk1G9XS/yE2wWk4uIleTl3e5Zefzoqq7j5fgmYDGKodWHe/vF3P7rF8PJbEJdHB4wG1W1bBSKaKOc5lhD4UgoURWs69OuP3WV59iMTx3d+Yyyb4737x6h6/4GqbdUfg==
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 Runtime Status"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"get"}
32 path={"/v1/status"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40Return the status of all connections (http, flight, metrics, opentelemetry) in the runtime.
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, either \"json\" or \"csv\". Defaults to \"json\".","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 connection statuses","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","endpoint","status"],"properties":{"endpoint":{"type":"string","description":"The endpoint of the connection (e.g., URL or IP address)"},"name":{"type":"string","description":"The name of the connection (e.g., \"http\", \"flight\", \"metrics\", \"opentelemetry\")"},"status":{"description":"The status of the component (e.g., Ready, Initializing, Disabled, Error, etc.)","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}},"title":"ConnectionDetails"}},"example":[{"name":"http","endpoint":"http://127.0.0.1:8080","status":"Ready"},{"name":"flight","endpoint":"http://127.0.0.1:9000","status":"Initializing"},{"name":"metrics","endpoint":"N/A","status":"Disabled"},{"name":"opentelemetry","endpoint":"http://127.0.0.1:4317","status":"Error"}]},"text/csv":{"schema":{"type":"string"},"example":"name,endpoint,status\nhttp,http://127.0.0.1:8080,Ready\nflight,http://127.0.0.1:9000,Initializing\nmetrics,N/A,Disabled\nopentelemetry,http://127.0.0.1:4317,Error"}}},"500":{"description":"Error converting to CSV","content":{"text/plain":{"schema":{"type":"string"},"example":"Error converting to CSV"}}}}}
67>
68
69</StatusCodes>
70
71
72