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: eJzVV1Fv2zYQ/ivEvaQ1GCUpsGHTW5G0Q4aiLZpue3AMh6bOFluKVEnKiWfovw9HUbacKFnQ9WUvaSIe77777uPddQtBrDzkU7gQQXgMHmYcCvTSqTooayCHz6XyDE1RW2UCcxgaZzwTTCsfmF0yac1SrRqHBSuSk4x9LpE59LU1HpkUhi2QLa2rRAhYMOHZZPL71Yf3kwmzjk0m51d/Tib82ghTMFEUikILzZZKB3S+dyDqWissWOOVWbFvDboNq4UTFZJVBhxsjU7Q5csCclhhmPeQgMPeFPLpFoyoEHLwQYSGjhUlG50CB4ffGuWwgHwptEcOXpZYCci3EDY13VtYq1EYaFu+89VleN/XfTp7Joi8MOApYx+t92qhka2FbtAz4ZAdffHWHLEXBS5Fo8NLIuxI+vVR9iyYPjhlVsABTVNRockdcJB+TaUOKmgye9shHybjbeMkPp3M21SgnmW22LDuHnuB2Srj7Ka2Pqwc+lyoAis7r9B7sUJ/8/JZCUz3GZhGa5i17YyudZR5Mnx1ekr/HCJ7l9Q5qL+0JqAJZBuVJKNSTiIh+fYhdXbxBWU4ADmFpbMVYSGO6GTnZ45GLDQWwEFIiToJcfd5xqF2pM+gOtijVg/1dZ/yv0oMJTo2vM7iC40eSFtRVSlxaHmHeUQSD4WZandbosOhFwqgrRQBC3LYKeQ5Dsmy1/kA0SET9/k+dHPe+GArtr/yIEUO+57xceh5H2nzXlQHwRLmth0v4vPrMLj9L2VInSbfgjX4YRmbUAoSpU1v7zDGhzo1wu7qfSL5o4/80qighFZ/d58/oSjo8V4o32v0jXPWxaOlQ192dldlE4Iyqwt7a4bd4dxWtTVowlWXQjsj3vrTNDo+pTd5GbCidPFOVDUZTLdJgbDrBX5jpO+fUQ6FUHoz/2IbZ4Se75QdgY5WJzWL8ScUXIPEZQpKbC2ckl99Xqo1zisMwgfrMEstNetb0h5Q/+VHY3msGe4jr9CgE/q7gsXDdkalwbtwQi1+rK/10h+UCK4NIeQEgo8E5mMBr81hPfmjZeQdbCLj2jy/HnysDAe+HuOTJxqTcfx5TbO65fDT2Li4NAFdfGno1ugY0vNgVsrG0WJzWyqN1IIk+rh8jI+VSHuthRofKGPEvzasMXhXo6TF6Nlh25hKhaG0adOJC04oIYeT9dnJAF+XUbfzNE5DDmUIdX5yQg1dl9aH/JfTX08fNLh3dMwKXKO2dYUmJG4ydt5vfOxWhZLdHB+Tx5sMaDR7lI1TYRPjiVrNvyL9PqMzZZY28pE6h2tMUHGQjoyiWkks2N5EK4nGx7mT3srrWsgSj19lBF4VaIJaKnSHJy0HSr9zfJb9nJ0eN8YHUnCcRNaHSpiB17g5XOz5O4C23Zf7f7UYJwUOBNryTg3bJJsprM8o28H/A0gbdLDdLoTHP5xuW/rcrYJU3qKfJ31firXer9RxjYUcutF23/gJYn/gijyaeYdzt65/J87/vP0+gW23fe+xzegPp6Jy6UFxKFEUpPfpNt16LSXWw4weLLrkZdc2fnvzGdr2Hz2I8XQ=
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: eJzVV1Fv2zYQ/ivEvaQ1GCUpsGHTW5G0Q4aiLZpue3AMh6bOFluKVEnKiWfovw9HUbacKFnQ9WUvaSIe77777uPddQtBrDzkU7gQQXgMHmYcCvTSqTooayCHz6XyDE1RW2UCcxgaZzwTTCsfmF0yac1SrRqHBSuSk4x9LpE59LU1HpkUhi2QLa2rRAhYMOHZZPL71Yf3kwmzjk0m51d/Tib82ghTMFEUikILzZZKB3S+dyDqWissWOOVWbFvDboNq4UTFZJVBhxsjU7Q5csCclhhmPeQgMPeFPLpFoyoEHLwQYSGjhUlG50CB4ffGuWwgHwptEcOXpZYCci3EDY13VtYq1EYaFu+89VleN/XfTp7Joi8MOApYx+t92qhka2FbtAz4ZAdffHWHLEXBS5Fo8NLIuxI+vVR9iyYPjhlVsABTVNRockdcJB+TaUOKmgye9shHybjbeMkPp3M21SgnmW22LDuHnuB2Srj7Ka2Pqwc+lyoAis7r9B7sUJ/8/JZCUz3GZhGa5i17YyudZR5Mnx1ekr/HCJ7l9Q5qL+0JqAJZBuVJKNSTiIh+fYhdXbxBWU4ADmFpbMVYSGO6GTnZ45GLDQWwEFIiToJcfd5xqF2pM+gOtijVg/1dZ/yv0oMJTo2vM7iC40eSFtRVSlxaHmHeUQSD4WZandbosOhFwqgrRQBC3LYKeQ5Dsmy1/kA0SET9/k+dHPe+GArtr/yIEUO+57xceh5H2nzXlQHwRLmth0v4vPrMLj9L2VInSbfgjX4YRmbUAoSpU1v7zDGhzo1wu7qfSL5o4/80qighFZ/d58/oSjo8V4o32v0jXPWxaOlQ192dldlE4Iyqwt7a4bd4dxWtTVowlWXQjsj3vrTNDo+pTd5GbCidPFOVDUZTLdJgbDrBX5jpO+fUQ6FUHoz/2IbZ4Se75QdgY5WJzWL8ScUXIPEZQpKbC2ckl99Xqo1zisMwgfrMEstNetb0h5Q/+VHY3msGe4jr9CgE/q7gsXDdkalwbtwQi1+rK/10h+UCK4NIeQEgo8E5mMBr81hPfmjZeQdbCLj2jy/HnysDAe+HuOTJxqTcfx5TbO65fDT2Li4NAFdfGno1ugY0vNgVsrG0WJzWyqN1IIk+rh8jI+VSHuthRofKGPEvzasMXhXo6TF6Nlh25hKhaG0adOJC04oIYeT9dnJAF+XUbfzNE5DDmUIdX5yQg1dl9aH/JfTX08fNLh3dMwKXKO2dYUmJG4ydt5vfOxWhZLdHB+Tx5sMaDR7lI1TYRPjiVrNvyL9PqMzZZY28pE6h2tMUHGQjoyiWkks2N5EK4nGx7mT3srrWsgSj19lBF4VaIJaKnSHJy0HSr9zfJb9nJ0eN8YHUnCcRNaHSpiB17g5XOz5O4C23Zf7f7UYJwUOBNryTg3bJJsprM8o28H/A0gbdLDdLoTHP5xuW/rcrYJU3qKfJ31firXer9RxjYUcutF23/gJYn/gijyaeYdzt65/J87/vP0+gW23fe+xzegPp6Jy6UFxKFEUpPfpNt16LSXWw4weLLrkZdc2fnvzGdr2Hz2I8XQ=
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