1---
2id: get-datasets
3title: "List Datasets"
4description: "This endpoint returns a list of configured datasets. The response can be formatted as **JSON** or **CSV**,"
5sidebar_label: "List Datasets"
6hide_title: true
7hide_table_of_contents: true
8api: eJztWVtv3DYW/isEXxIbtOwGWGArYB8MO93NomiK2tk+WAOLls6MmEikSlIzmR3ovy8OL7rMjN2J26dFX1pHJM/9fOcyO2r5ytD0gd5yyw1YQxeMlmAKLVorlKQpva+EISDLVglpiQbbaWkIJ7UwlqglKZRcilWnoSRlIJKQ+wqIBtMqaYAUXJInIEulG24tlIQbcn7+77uPP52fE6XJ+fnN3X/Oz1kmuSwJL0uBrHlNlqK2oE0kwNu2FlCSzgi5Ir91oLek5Zo3gLeSTGbykwGSG8ttZ/5hdQf5/jViFRGyqLsSiK2AFJ3WIC3xb1Af4EUVNSFCultRlSSTPytjxFMN8cWa1x2YlORCCit4Lf4r5CpnJNfAyy3+UQrDn2oo8W/QWml/utRgqnDXVJ21Qq5KtZF5kslfK5B7ejjTjHIZFC1/H8hNZSS8NoOOJs3kRWSbEmN1V1jnq0KVQNTTZygs2QhbkbzgFlZKO5nttoWcOabGovQkxwf5SO2xAWP4CvKUdAb0xVp4s5RguagNZVS1oDl68kNJU7oC+xjjgzI6+o2mDzsqeQM0pV5jyqjAyHOuo/vx+GsFtjp0ZHDHUkBdHriNeIM6S+5ZKxoqkyeEw1tIVsnUt4dOn7rVm/0syeQtLHlXW4NS50teG8gTyqiG3zqhoaSp+8aoKSpoOE13FD1AU/qkVA1c0r5ng5V8Ir1sJUxAfw+VmBtjCGEfu4RrIG8+GyXfkLelF/QM8/JNYdZvThPTWC3kijIKsmsQT5AcZbQwa0QUK2yN137wkk+VMarTBbyszA8BB2L8kKct8e8Gj7TK2JUGk3JRQqNidJr87CQFHkYNZFfXdNH3C3zmTWbw4rurK/zfXLIfAwiOyHckdYUhpoVCLAWUbB9ffPTFFz7PXdyQBizHe+TtCBvz1DsjG+TmcLHALEVdCyUtSIuyhgOU9dI5JN0dus5jwIHNbwcJfRgJJQP4Q4n2x5DKL9ffXUbV86FIzC3+QJdaNWhYdDieDEI9gnTISBnlRQF1wIvh84LRViOMWOF9cPTWYbI8BxnT58RVNUcBE8XpE1ShPaPO0EhaSfi4dBgVmLj4wACe87iWRLWhbnn/4f1LB7N79AO6JJn8KOstaVXb1Rzr4uY47B8+ReED+CeZfP+VN20NaSbzHcloxPGMpiSj4WFGGcmcCv4z72zlv6GEs6uJPyO9g6j9KJk6NnKK15gjdui24d5B/vxLrKqLGtZQk0I1rZIIvvE62kN7dPcWVVqshERTTSQ7gJ7oRUYbVUJNGd0o/QU0Ct9JKxqYQtJNZOvMeRMl7YMuRyBursGdL48NLyoh4QIrg/vgHP8230Vl+mSHhPr8jBHELJJPzZ0nyNFz2rfRDZdKimIWV0RgkpchdlutVpo3mKUFqbgsayFXL5kIWXqokFA4NmiQBlSHZlvzWpQ8fJbKPi5VJzFJW9CNMMYfaG7hsRaN8JXIgpYcjd3JL1Jt5PM2vkeh+v65Y9ovYv5FoHsBp/fdcZiGgQbx956wddxU21lSAUqPfakMbzDL4JT8ZC8np++gBrJRlA03REOhdAllkknXYbta7Pu6iWfnrZUwbc23LlQcpv5ucGIXEArlmEuTHrJWhVPsoIqarSxMfoacfJ0+hRPejN3GBErnWPBy1bnpjFUNGZ8cYDOj44Dw85TyyGn7E29mzILMGHPHqs/pBWTy+nfqR+hkv6GA3B9tPydkE+LCMbQMR6vF/rAz7Tyms8swtHzY619/iY3t7WRoibGc/zLrbu/C0HLrhhZs+Pc1fSFWRrR3IT9K4TJGKku2gNMmL7cT3JqKSxdow2/k5AhiE46tQGvJiIBmwsZZ4VX046w3aKE7KefYGy07o/9MOlxH5FCFC41hshmYMj+88edgb69ie4Q9KNDvY7dzOsr+Ubn6/hXmDVxarQowLj/GgYsIazxwzzwZj1/lzkN+cVInOKpPGE2TgS5weADfldE0hNNY7+4CHC2mRTD02x/kUrn+M75+2AWsp3Nwjg11Sksu6u3jZ9VhAX4celzXVh+FuzADHW+mEUhG+BpkD/0whsNBccaPaNwgJ8LVkxbFF5NWYg2POMcYqzQkYbhM4nA26hC//Nni+8CetPNjKzrpE0NUDF1RCeOxa8/oYUdCPzmWDks6W4G0KCj4sHdvfd0tNJR4yGtDJ0Z6bl4dTbICCdp1VN9uhTjlRjPMcPMEZ2IHZuGrvcT5/djQGCvqNMwziboxFJ8dEZkdE5V5EZkTgs1EyeQ84Nmzcc68us71Ll4Zy+TpUciOBd+UpgsiNo0H9u3On6iz53IWPB1Y+v9OPYbqOLykfzu2g/gQem9iQK9B7yPzphL1AGEOucYt3GRX4Nzd1lwc3xIcc/i1JJ2Ery0U2EOezLZ3qjRgKxUWg24faCua0ulCgTLqNfIrwk7XNKWVtW16eYmNa10pY9O/X31/dQDkP+IxKXGuVG3jOipHKSE3cVsdlp4XF0gRx68Fsis6LezW8eOtePwC+LeDc9yDOHsEvI6j5NGWuxUFlGS8UosCpHFtdMju65YXFVy8S1B44YJkKUDPT3pGUX1P+F1ylVxddNLvY11jrYxtuJxQdeuo29F+M9F2o7v/Wur/tdR/3VI/wMEELXrmU3MXcviBrr/D0Jv8oISJige73RM38EnXfY+f/bIXcy1ac6hczwbu/9P2/6gtHeSMP4S4SKQp9QPjyWb6U9f/L8g5/BTxSjn/8Gb/JRvGXxZG2Rb4Dy0cgCKuM1oBLxF2H3bh1bUbDCevDpboSGWoXv98f0/7/n/s8nK9
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";
22import Translate from "@docusaurus/Translate";
23
24<Heading
25 as={"h1"}
26 className={"openapi__heading"}
27 children={"List Datasets"}
28>
29</Heading>
30
31<MethodEndpoint
32 method={"get"}
33 path={"/v1/datasets"}
34 context={"endpoint"}
35>
36
37</MethodEndpoint>
38
39
40
41This endpoint returns a list of configured datasets. The response can be formatted as **JSON** or **CSV**,
42and additional filters can be applied using query parameters.
43
44Use `status=true` query parameter to include the current status of each dataset in the response.
45Possible status values: `initializing`, `ready`, `disabled`, `error`, `refreshing`, `shuttingdown`.
46When `status=true` and a dataset is in `Error`, the response also includes:
47- `error`: structured code object with `category`, `type`, and stable `code`
48- `error_message`: user-visible details
49
50<Heading
51 id={"request"}
52 as={"h2"}
53 className={"openapi-tabs__heading"}
54>
55 <Translate id="theme.openapi.request.title">Request</Translate>
56</Heading>
57
58<ParamsDetails
59 {...require("./get-datasets.ParamsDetails.json")}
60>
61
62</ParamsDetails>
63
64<RequestSchema
65 {...require("./get-datasets.RequestSchema.json")}
66>
67
68</RequestSchema>
69
70<StatusCodes
71 {...require("./get-datasets.StatusCodes.json")}
72>
73
74</StatusCodes>
75
76
77
1---
2id: get-datasets
3title: "List Datasets"
4description: "This endpoint returns a list of configured datasets. The response can be formatted as **JSON** or **CSV**,"
5sidebar_label: "List Datasets"
6hide_title: true
7hide_table_of_contents: true
8api: eJztWVtv3DYW/isEXxIbtOwGWGArYB8MO93NomiK2tk+WAOLls6MmEikSlIzmR3ovy8OL7rMjN2J26dFX1pHJM/9fOcyO2r5ytD0gd5yyw1YQxeMlmAKLVorlKQpva+EISDLVglpiQbbaWkIJ7UwlqglKZRcilWnoSRlIJKQ+wqIBtMqaYAUXJInIEulG24tlIQbcn7+77uPP52fE6XJ+fnN3X/Oz1kmuSwJL0uBrHlNlqK2oE0kwNu2FlCSzgi5Ir91oLek5Zo3gLeSTGbykwGSG8ttZ/5hdQf5/jViFRGyqLsSiK2AFJ3WIC3xb1Af4EUVNSFCultRlSSTPytjxFMN8cWa1x2YlORCCit4Lf4r5CpnJNfAyy3+UQrDn2oo8W/QWml/utRgqnDXVJ21Qq5KtZF5kslfK5B7ejjTjHIZFC1/H8hNZSS8NoOOJs3kRWSbEmN1V1jnq0KVQNTTZygs2QhbkbzgFlZKO5nttoWcOabGovQkxwf5SO2xAWP4CvKUdAb0xVp4s5RguagNZVS1oDl68kNJU7oC+xjjgzI6+o2mDzsqeQM0pV5jyqjAyHOuo/vx+GsFtjp0ZHDHUkBdHriNeIM6S+5ZKxoqkyeEw1tIVsnUt4dOn7rVm/0syeQtLHlXW4NS50teG8gTyqiG3zqhoaSp+8aoKSpoOE13FD1AU/qkVA1c0r5ng5V8Ir1sJUxAfw+VmBtjCGEfu4RrIG8+GyXfkLelF/QM8/JNYdZvThPTWC3kijIKsmsQT5AcZbQwa0QUK2yN137wkk+VMarTBbyszA8BB2L8kKct8e8Gj7TK2JUGk3JRQqNidJr87CQFHkYNZFfXdNH3C3zmTWbw4rurK/zfXLIfAwiOyHckdYUhpoVCLAWUbB9ffPTFFz7PXdyQBizHe+TtCBvz1DsjG+TmcLHALEVdCyUtSIuyhgOU9dI5JN0dus5jwIHNbwcJfRgJJQP4Q4n2x5DKL9ffXUbV86FIzC3+QJdaNWhYdDieDEI9gnTISBnlRQF1wIvh84LRViOMWOF9cPTWYbI8BxnT58RVNUcBE8XpE1ShPaPO0EhaSfi4dBgVmLj4wACe87iWRLWhbnn/4f1LB7N79AO6JJn8KOstaVXb1Rzr4uY47B8+ReED+CeZfP+VN20NaSbzHcloxPGMpiSj4WFGGcmcCv4z72zlv6GEs6uJPyO9g6j9KJk6NnKK15gjdui24d5B/vxLrKqLGtZQk0I1rZIIvvE62kN7dPcWVVqshERTTSQ7gJ7oRUYbVUJNGd0o/QU0Ct9JKxqYQtJNZOvMeRMl7YMuRyBursGdL48NLyoh4QIrg/vgHP8230Vl+mSHhPr8jBHELJJPzZ0nyNFz2rfRDZdKimIWV0RgkpchdlutVpo3mKUFqbgsayFXL5kIWXqokFA4NmiQBlSHZlvzWpQ8fJbKPi5VJzFJW9CNMMYfaG7hsRaN8JXIgpYcjd3JL1Jt5PM2vkeh+v65Y9ovYv5FoHsBp/fdcZiGgQbx956wddxU21lSAUqPfakMbzDL4JT8ZC8np++gBrJRlA03REOhdAllkknXYbta7Pu6iWfnrZUwbc23LlQcpv5ucGIXEArlmEuTHrJWhVPsoIqarSxMfoacfJ0+hRPejN3GBErnWPBy1bnpjFUNGZ8cYDOj44Dw85TyyGn7E29mzILMGHPHqs/pBWTy+nfqR+hkv6GA3B9tPydkE+LCMbQMR6vF/rAz7Tyms8swtHzY619/iY3t7WRoibGc/zLrbu/C0HLrhhZs+Pc1fSFWRrR3IT9K4TJGKku2gNMmL7cT3JqKSxdow2/k5AhiE46tQGvJiIBmwsZZ4VX046w3aKE7KefYGy07o/9MOlxH5FCFC41hshmYMj+88edgb69ie4Q9KNDvY7dzOsr+Ubn6/hXmDVxarQowLj/GgYsIazxwzzwZj1/lzkN+cVInOKpPGE2TgS5weADfldE0hNNY7+4CHC2mRTD02x/kUrn+M75+2AWsp3Nwjg11Sksu6u3jZ9VhAX4celzXVh+FuzADHW+mEUhG+BpkD/0whsNBccaPaNwgJ8LVkxbFF5NWYg2POMcYqzQkYbhM4nA26hC//Nni+8CetPNjKzrpE0NUDF1RCeOxa8/oYUdCPzmWDks6W4G0KCj4sHdvfd0tNJR4yGtDJ0Z6bl4dTbICCdp1VN9uhTjlRjPMcPMEZ2IHZuGrvcT5/djQGCvqNMwziboxFJ8dEZkdE5V5EZkTgs1EyeQ84Nmzcc68us71Ll4Zy+TpUciOBd+UpgsiNo0H9u3On6iz53IWPB1Y+v9OPYbqOLykfzu2g/gQem9iQK9B7yPzphL1AGEOucYt3GRX4Nzd1lwc3xIcc/i1JJ2Ery0U2EOezLZ3qjRgKxUWg24faCua0ulCgTLqNfIrwk7XNKWVtW16eYmNa10pY9O/X31/dQDkP+IxKXGuVG3jOipHKSE3cVsdlp4XF0gRx68Fsis6LezW8eOtePwC+LeDc9yDOHsEvI6j5NGWuxUFlGS8UosCpHFtdMju65YXFVy8S1B44YJkKUDPT3pGUX1P+F1ylVxddNLvY11jrYxtuJxQdeuo29F+M9F2o7v/Wur/tdR/3VI/wMEELXrmU3MXcviBrr/D0Jv8oISJige73RM38EnXfY+f/bIXcy1ac6hczwbu/9P2/6gtHeSMP4S4SKQp9QPjyWb6U9f/L8g5/BTxSjn/8Gb/JRvGXxZG2Rb4Dy0cgCKuM1oBLxF2H3bh1bUbDCevDpboSGWoXv98f0/7/n/s8nK9
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";
22import Translate from "@docusaurus/Translate";
23
24<Heading
25 as={"h1"}
26 className={"openapi__heading"}
27 children={"List Datasets"}
28>
29</Heading>
30
31<MethodEndpoint
32 method={"get"}
33 path={"/v1/datasets"}
34 context={"endpoint"}
35>
36
37</MethodEndpoint>
38
39
40
41This endpoint returns a list of configured datasets. The response can be formatted as **JSON** or **CSV**,
42and additional filters can be applied using query parameters.
43
44Use `status=true` query parameter to include the current status of each dataset in the response.
45Possible status values: `initializing`, `ready`, `disabled`, `error`, `refreshing`, `shuttingdown`.
46When `status=true` and a dataset is in `Error`, the response also includes:
47- `error`: structured code object with `category`, `type`, and stable `code`
48- `error_message`: user-visible details
49
50<Heading
51 id={"request"}
52 as={"h2"}
53 className={"openapi-tabs__heading"}
54>
55 <Translate id="theme.openapi.request.title">Request</Translate>
56</Heading>
57
58<ParamsDetails
59 {...require("./get-datasets.ParamsDetails.json")}
60>
61
62</ParamsDetails>
63
64<RequestSchema
65 {...require("./get-datasets.RequestSchema.json")}
66>
67
68</RequestSchema>
69
70<StatusCodes
71 {...require("./get-datasets.StatusCodes.json")}
72>
73
74</StatusCodes>
75
76
77