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: eJzVVt9v2zYQ/leIe0lrMEpaYMCqtyBphwxFWzTd9uAYDk2dLaYUqZKUU8/Q/z4cRdlyomRB15e95Id4vPvuu493t4UgVh7yKVyIIDwGDzMOBXrpVB2UNZDDl1J5hqaorTKBOQyNM54JppUPzC6ZtGapVo3DghXJSca+lMgc+toaj0wKwxbIltZVIgQsmPBsMvn96uOHyYRZxyaT86s/JxN+bYQpmCgKRaGFZkulAzrfOxB1rRUWrPHKrNi3Bt2G1cKJCskqAw62Rifo8mUBOawwzHtIwGFvCvl0C0ZUCDn4IEJDx4qSjU6Bg8NvjXJYQL4U2iMHL0usBORbCJua7i2s1SgMtC3f+eoyvO/rPp09E0ReGPCUsU/We7XQyNZCN+iZcMiObr01R+xFgUvR6PCSCDuSfn2UPQumD06ZFXBA01RUaHIHHKRfU6mDCprM3nXIh8l42ziJTyfzLhWoZ5ktNqy7x15gtso4u6mtDyuHPheqwMrOK/RerNDfvHxWAtN9BqbRGmZtO6NrHWWeDF+fntKvQ2TvkzoH9ZfWBDSBbKOSZFTKSSQk3z6kzi5uUYYDkFNYOlsRFuKITnZ+5mjEQmMBHISUqJMQd59nHGpH+gyqgz1q9VBf9yn/q8RQomPD6yy+0OiBtBVVlRKHlneYRyTxUJipdnclOhx6oQDaShGwIIedQp7jkCx7nQ8QHTJxn+9DN+eND7Zi+ysPUuSw7xmfhp73kTYfRHUQLGFu2/EiPr8Og9v/UobUafItWIMfl7EJpSBR2vT2DmN8rFMj7K7eJ5I/+sgvjQpKaPV39/kzioIe74XyvUbfOmddPFo69GVnd1U2ISizurB3Ztgdzm1VW4MmXHUptDPirT9No+NzepOXAStKF7+LqiaD6TYpEHa9wG+M9P0zyqEQSm/mt7ZxRuj5TtkR6Gh1UrMYf0LBNUhcpqDE1sIp+dXnpVrjvMIgfLAOs9RSs74l7QH1X342lsea4T7yCg06oX8oWDxsZ1Qa/B5OqMWP9bVe+oMSwbUhhJxA8JHAfCzgtTmsJ3+0jLyDTWRcm+fXg4+V4cDXY3zyRGMyjj+vaVa3HH4ZGxeXJqCLLw3dGh1Deh7MStk4WmzuSqWRWpBEH5eP8bESaa+1UOMDZYz4M8Mag99rlLQYPTtsG1OpMJQ2bTpxwQkl5HCyfnUywNdl1O08jdOQQxlCnZ+cUEPXpfUh//X0zemDBveejlmBa9S2rtCExE3GzvuNj92pULKb42PyeJMBjWaPsnEqbGI8Uav5V6S/Z3SmzNJGPlLncI0JKg7SkVFUK4kF25toJdH4OHfSWzmrhSzx+HVG4FWBJqilQnd40nKg9DvHr7I32es4gKwPlTADZ3FhuNjTdoBou6/y/2ofTsIb6LLlnQi2SS1TWL+ibAfrP0mCDrbbhfD4h9NtS5+7DZCqWvRjpG9HscT7TTpur5BDN9HuGz9B7E/cjEcz73DutvQfxPmfl94nsO2W7j22Gf3jFIGL74hDiaIgmU+36daZlFgPM3qw35KXXbf47e0XaNt/AHl07e4=
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 Datasets"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"get"}
32 path={"/v1/datasets"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40This endpoint returns a list of configured datasets. The response can be formatted as **JSON** or **CSV**,
41and additional filters can be applied using query parameters.
42
43<Heading
44 id={"request"}
45 as={"h2"}
46 className={"openapi-tabs__heading"}
47 children={"Request"}
48>
49</Heading>
50
51<ParamsDetails
52 parameters={[{"name":"status","in":"query","required":false,"schema":{"type":"boolean"}},{"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"}},{"name":"source","in":"query","description":"Filters datasets by source (e.g., `postgres:aidemo_messages`).","required":false,"schema":{"type":["string","null"]}}]}
53>
54
55</ParamsDetails>
56
57<RequestSchema
58 title={"Body"}
59 body={undefined}
60>
61
62</RequestSchema>
63
64<StatusCodes
65 id={undefined}
66 label={undefined}
67 responses={{"200":{"description":"List of datasets","content":{"application/json":{"schema":{"type":"object","required":["from","name","replication_enabled","acceleration_enabled"],"properties":{"acceleration_enabled":{"type":"boolean","description":"Whether acceleration is enabled for the dataset"},"from":{"type":"string","description":"The source where the dataset is located"},"name":{"type":"string","description":"The name of the dataset"},"properties":{"type":"object","description":"Custom properties for the dataset","additionalProperties":{},"propertyNames":{"type":"string"}},"replication_enabled":{"type":"boolean","description":"Whether replication is enabled for the dataset"},"status":{"oneOf":[{"type":"null"},{"description":"Optional status of the dataset","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}]}},"title":"DatasetResponseItem"},"example":[{"from":"postgres:syncs","name":"daily_journal_accelerated","replication_enabled":false,"acceleration_enabled":true},{"from":"databricks:hive_metastore.default.messages","name":"messages_accelerated","replication_enabled":false,"acceleration_enabled":true},{"from":"postgres:aidemo_messages","name":"general","replication_enabled":false,"acceleration_enabled":false}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name,replication_enabled,acceleration_enabled\npostgres:syncs,daily_journal_accelerated,false,true\ndatabricks:hive_metastore.default.messages,messages_accelerated,false,true\npostgres:aidemo_messages,general,false,false\n"}}},"500":{"description":"Internal server error occurred while processing datasets","content":{"text/plain":{"schema":{"type":"string"},"example":"An unexpected error occurred while processing datasets"}}}}}
68>
69
70</StatusCodes>
71
72
73
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: eJzVVt9v2zYQ/leIe0lrMEpaYMCqtyBphwxFWzTd9uAYDk2dLaYUqZKUU8/Q/z4cRdlyomRB15e95Id4vPvuu493t4UgVh7yKVyIIDwGDzMOBXrpVB2UNZDDl1J5hqaorTKBOQyNM54JppUPzC6ZtGapVo3DghXJSca+lMgc+toaj0wKwxbIltZVIgQsmPBsMvn96uOHyYRZxyaT86s/JxN+bYQpmCgKRaGFZkulAzrfOxB1rRUWrPHKrNi3Bt2G1cKJCskqAw62Rifo8mUBOawwzHtIwGFvCvl0C0ZUCDn4IEJDx4qSjU6Bg8NvjXJYQL4U2iMHL0usBORbCJua7i2s1SgMtC3f+eoyvO/rPp09E0ReGPCUsU/We7XQyNZCN+iZcMiObr01R+xFgUvR6PCSCDuSfn2UPQumD06ZFXBA01RUaHIHHKRfU6mDCprM3nXIh8l42ziJTyfzLhWoZ5ktNqy7x15gtso4u6mtDyuHPheqwMrOK/RerNDfvHxWAtN9BqbRGmZtO6NrHWWeDF+fntKvQ2TvkzoH9ZfWBDSBbKOSZFTKSSQk3z6kzi5uUYYDkFNYOlsRFuKITnZ+5mjEQmMBHISUqJMQd59nHGpH+gyqgz1q9VBf9yn/q8RQomPD6yy+0OiBtBVVlRKHlneYRyTxUJipdnclOhx6oQDaShGwIIedQp7jkCx7nQ8QHTJxn+9DN+eND7Zi+ysPUuSw7xmfhp73kTYfRHUQLGFu2/EiPr8Og9v/UobUafItWIMfl7EJpSBR2vT2DmN8rFMj7K7eJ5I/+sgvjQpKaPV39/kzioIe74XyvUbfOmddPFo69GVnd1U2ISizurB3Ztgdzm1VW4MmXHUptDPirT9No+NzepOXAStKF7+LqiaD6TYpEHa9wG+M9P0zyqEQSm/mt7ZxRuj5TtkR6Gh1UrMYf0LBNUhcpqDE1sIp+dXnpVrjvMIgfLAOs9RSs74l7QH1X342lsea4T7yCg06oX8oWDxsZ1Qa/B5OqMWP9bVe+oMSwbUhhJxA8JHAfCzgtTmsJ3+0jLyDTWRcm+fXg4+V4cDXY3zyRGMyjj+vaVa3HH4ZGxeXJqCLLw3dGh1Deh7MStk4WmzuSqWRWpBEH5eP8bESaa+1UOMDZYz4M8Mag99rlLQYPTtsG1OpMJQ2bTpxwQkl5HCyfnUywNdl1O08jdOQQxlCnZ+cUEPXpfUh//X0zemDBveejlmBa9S2rtCExE3GzvuNj92pULKb42PyeJMBjWaPsnEqbGI8Uav5V6S/Z3SmzNJGPlLncI0JKg7SkVFUK4kF25toJdH4OHfSWzmrhSzx+HVG4FWBJqilQnd40nKg9DvHr7I32es4gKwPlTADZ3FhuNjTdoBou6/y/2ofTsIb6LLlnQi2SS1TWL+ibAfrP0mCDrbbhfD4h9NtS5+7DZCqWvRjpG9HscT7TTpur5BDN9HuGz9B7E/cjEcz73DutvQfxPmfl94nsO2W7j22Gf3jFIGL74hDiaIgmU+36daZlFgPM3qw35KXXbf47e0XaNt/AHl07e4=
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 Datasets"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"get"}
32 path={"/v1/datasets"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40This endpoint returns a list of configured datasets. The response can be formatted as **JSON** or **CSV**,
41and additional filters can be applied using query parameters.
42
43<Heading
44 id={"request"}
45 as={"h2"}
46 className={"openapi-tabs__heading"}
47 children={"Request"}
48>
49</Heading>
50
51<ParamsDetails
52 parameters={[{"name":"status","in":"query","required":false,"schema":{"type":"boolean"}},{"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"}},{"name":"source","in":"query","description":"Filters datasets by source (e.g., `postgres:aidemo_messages`).","required":false,"schema":{"type":["string","null"]}}]}
53>
54
55</ParamsDetails>
56
57<RequestSchema
58 title={"Body"}
59 body={undefined}
60>
61
62</RequestSchema>
63
64<StatusCodes
65 id={undefined}
66 label={undefined}
67 responses={{"200":{"description":"List of datasets","content":{"application/json":{"schema":{"type":"object","required":["from","name","replication_enabled","acceleration_enabled"],"properties":{"acceleration_enabled":{"type":"boolean","description":"Whether acceleration is enabled for the dataset"},"from":{"type":"string","description":"The source where the dataset is located"},"name":{"type":"string","description":"The name of the dataset"},"properties":{"type":"object","description":"Custom properties for the dataset","additionalProperties":{},"propertyNames":{"type":"string"}},"replication_enabled":{"type":"boolean","description":"Whether replication is enabled for the dataset"},"status":{"oneOf":[{"type":"null"},{"description":"Optional status of the dataset","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}]}},"title":"DatasetResponseItem"},"example":[{"from":"postgres:syncs","name":"daily_journal_accelerated","replication_enabled":false,"acceleration_enabled":true},{"from":"databricks:hive_metastore.default.messages","name":"messages_accelerated","replication_enabled":false,"acceleration_enabled":true},{"from":"postgres:aidemo_messages","name":"general","replication_enabled":false,"acceleration_enabled":false}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name,replication_enabled,acceleration_enabled\npostgres:syncs,daily_journal_accelerated,false,true\ndatabricks:hive_metastore.default.messages,messages_accelerated,false,true\npostgres:aidemo_messages,general,false,false\n"}}},"500":{"description":"Internal server error occurred while processing datasets","content":{"text/plain":{"schema":{"type":"string"},"example":"An unexpected error occurred while processing datasets"}}}}}
68>
69
70</StatusCodes>
71
72
73