1---
2id: get-iceberg-namespaces
3title: "List Iceberg namespaces"
4description: "This endpoint retrieves namespaces available in the Iceberg catalog."
5sidebar_label: "List Iceberg namespaces"
6hide_title: true
7hide_table_of_contents: true
8api: eNrtV1Fv2zgM/iuCntMk7XXAlrdu6+4KbBmwtk+5IFVsOtZOljRJzloE+e9HWnZsw0Y3YAMON+wpDklR30d+kukDD2Ln+WLFbxLYgtvx9YSn4BMnbZBG8wW/y6VnoFNrpA7MQXAS9uCZFgV4KxJ8FHshldgqYFKzkAOrk7FEBKHMbvq3vsmYYA9WONDhoV3LMLd1Zi9TSCdMBvZVKsWU9KHKk+RSpd2dSp2Cq1zeQiIzCSmLSad8wo0FJwj2TYrAdxA2MgLZtCkwDBfg3wCOiB84+TA8pkG3JNZfSnBPfFgLqLfrUMicKdjXXCY5C+ZUoAF2AujgSykdILpMKA8T7pMcCsEXBx6eLKEw28+QhF7oiqAFT53BUiHFIJEGLonmdq1wThBmGaDo2j0i0jt+PB4nPMigyLZscKF5Tbt5a7SPeS/mc/rpU1+2TWgopsyXCRp8VipFGydGB6ohLhbWKplUzZh99pTh8J1kO60aMO74vk37vyjlmNl/qovL0QuPorDk75NZnSCseH1oNoKvj5MR+5Y3utmcY8j6WG17Oda01yJlxB58+FntAeeMGxYwmr+xFvl6sQO0VlGEKIVhrsrapsJrB3bgMDwzrhAhmv64QEMhtSzKgi/mWIEm+7Bb9X4DB7ZD0+oVX5rbMslPLbt+TCDWcEI1/BRL2LXeICinhboFtwd33RSlaX59AVb2O9qzq4yuc8zR6KUO6InmVOcTW4SyF0p2rppOy2u+4xxinVE4x0ZCl8+ce6ZNYJnBG/i3lH5VKbXNbl7KLDX0rsfWw6PsSuoZmo2uLmtdvRi7mhrWzFe0WUTzW1m/7CVVtztiYdWyBXv7bnP75q/rD1eb5ce7zbuP98u3rcTG4DfqelHfWlVJQ27qga+a7kKOf2b781lv6os6i+/a0ikMyUOwi9lMmUSo3PiweDl/NR/MfO/JzVKcd5SxBY1+MdOUvTE6k7vSAU6tIWcPZ2eU8WHKaaLykJROhqdqP2Hl5h+g5zX5pM5M1ei6pK7UQRYwOm56izMsvsVPIXgkgIaJxWlyvUKKOZxdTAk8HlqMxMHY9T1YKKIfE59PX00vyGSRdiF0J9l7mr2b+b1XwB62Q3tQ/09fCLWyAjyGmVUCR30sQqWGQy2cFd+fY2B/CiV1kOtw2AoP904dj2SOHwnU4FR6YtcO9s8U68c+IUYZVNpqv2BwHigpqBLiXjhJ2CrxIRUQKWkDQcdVVwldGJ1Vg2uXspwO2Z/Xd3gd/As43PMG
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 Iceberg namespaces"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"get"}
32 path={"/v1/namespaces"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40This endpoint retrieves namespaces available in the Iceberg catalog.
41If a `parent` namespace is provided, it will list the child namespaces under the specified parent.
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":"parent","in":"query","description":"The parent namespace from which to retrieve child namespaces.","required":false,"schema":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"}}]}
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":"Namespaces retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["namespaces"],"properties":{"namespaces":{"type":"array","items":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"}}},"title":"NamespacesResponse"},"example":{"namespaces":[{"parts":["catalog_a"]},{"parts":["catalog_b","schema_1"]}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Invalid namespace request","type":"BadRequestException","code":400}}}}},"404":{"description":"Namespace not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Namespace provided does not exist","type":"NoSuchNamespaceException","code":404}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Internal Server Error: DF_SCHEMA_NOT_FOUND","type":"InternalServerError","code":500}}}}}}}
68>
69
70</StatusCodes>
71
72
73
1---
2id: get-iceberg-namespaces
3title: "List Iceberg namespaces"
4description: "This endpoint retrieves namespaces available in the Iceberg catalog."
5sidebar_label: "List Iceberg namespaces"
6hide_title: true
7hide_table_of_contents: true
8api: eNrtV1Fv2zgM/iuCntMk7XXAlrdu6+4KbBmwtk+5IFVsOtZOljRJzloE+e9HWnZsw0Y3YAMON+wpDklR30d+kukDD2Ln+WLFbxLYgtvx9YSn4BMnbZBG8wW/y6VnoFNrpA7MQXAS9uCZFgV4KxJ8FHshldgqYFKzkAOrk7FEBKHMbvq3vsmYYA9WONDhoV3LMLd1Zi9TSCdMBvZVKsWU9KHKk+RSpd2dSp2Cq1zeQiIzCSmLSad8wo0FJwj2TYrAdxA2MgLZtCkwDBfg3wCOiB84+TA8pkG3JNZfSnBPfFgLqLfrUMicKdjXXCY5C+ZUoAF2AujgSykdILpMKA8T7pMcCsEXBx6eLKEw28+QhF7oiqAFT53BUiHFIJEGLonmdq1wThBmGaDo2j0i0jt+PB4nPMigyLZscKF5Tbt5a7SPeS/mc/rpU1+2TWgopsyXCRp8VipFGydGB6ohLhbWKplUzZh99pTh8J1kO60aMO74vk37vyjlmNl/qovL0QuPorDk75NZnSCseH1oNoKvj5MR+5Y3utmcY8j6WG17Oda01yJlxB58+FntAeeMGxYwmr+xFvl6sQO0VlGEKIVhrsrapsJrB3bgMDwzrhAhmv64QEMhtSzKgi/mWIEm+7Bb9X4DB7ZD0+oVX5rbMslPLbt+TCDWcEI1/BRL2LXeICinhboFtwd33RSlaX59AVb2O9qzq4yuc8zR6KUO6InmVOcTW4SyF0p2rppOy2u+4xxinVE4x0ZCl8+ce6ZNYJnBG/i3lH5VKbXNbl7KLDX0rsfWw6PsSuoZmo2uLmtdvRi7mhrWzFe0WUTzW1m/7CVVtztiYdWyBXv7bnP75q/rD1eb5ce7zbuP98u3rcTG4DfqelHfWlVJQ27qga+a7kKOf2b781lv6os6i+/a0ikMyUOwi9lMmUSo3PiweDl/NR/MfO/JzVKcd5SxBY1+MdOUvTE6k7vSAU6tIWcPZ2eU8WHKaaLykJROhqdqP2Hl5h+g5zX5pM5M1ei6pK7UQRYwOm56izMsvsVPIXgkgIaJxWlyvUKKOZxdTAk8HlqMxMHY9T1YKKIfE59PX00vyGSRdiF0J9l7mr2b+b1XwB62Q3tQ/09fCLWyAjyGmVUCR30sQqWGQy2cFd+fY2B/CiV1kOtw2AoP904dj2SOHwnU4FR6YtcO9s8U68c+IUYZVNpqv2BwHigpqBLiXjhJ2CrxIRUQKWkDQcdVVwldGJ1Vg2uXspwO2Z/Xd3gd/As43PMG
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 Iceberg namespaces"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"get"}
32 path={"/v1/namespaces"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40This endpoint retrieves namespaces available in the Iceberg catalog.
41If a `parent` namespace is provided, it will list the child namespaces under the specified parent.
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":"parent","in":"query","description":"The parent namespace from which to retrieve child namespaces.","required":false,"schema":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"}}]}
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":"Namespaces retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["namespaces"],"properties":{"namespaces":{"type":"array","items":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","items":{"type":"string"}}},"title":"Namespace"}}},"title":"NamespacesResponse"},"example":{"namespaces":[{"parts":["catalog_a"]},{"parts":["catalog_b","schema_1"]}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Invalid namespace request","type":"BadRequestException","code":400}}}}},"404":{"description":"Namespace not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Namespace provided does not exist","type":"NoSuchNamespaceException","code":404}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"code":{"type":"integer","format":"int32","minimum":0},"message":{"type":"string"},"type":{"type":"string","enum":["NoSuchNamespaceException","BadRequestException","InternalServerError"],"title":"IcebergErrorType"}},"title":"IcebergError"}},"title":"IcebergResponseError"},"example":{"error":{"message":"Internal Server Error: DF_SCHEMA_NOT_FOUND","type":"InternalServerError","code":500}}}}}}}
68>
69
70</StatusCodes>
71
72
73