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/iuCntMk7XXDXd66rbsrsGXA2j1lQarYdKydLGmSnLUI8t9HWnZsw0Y3YAMON+wpDklR30d+kukDD2Ln+WLFbxLYgtvx9YSn4BMnbZBG8wW/y6VnoFNrpA7MQXAS9uCZFgV4KxJ8FHshldgqYFKzkAOrk7FEBKHMbvpR32RMsHsrHOhw365lmNs6s5cppBMmA/silWJK+lDlSXKp0u5OpU7BVS5vIZGZhJTFpFM+4caCEwT7JkXgOwgbGYFs2hQYhgvwbwBHxA+cfBge06BbEuvPJbhHPqwF1Nt1KGTOFOxLLpOcBXMq0AA7AXTwuZQOEF0mlIcJ90kOheCLAw+PllCY7SdIQi90RdCCp85gqZBikEgDl0Rzu1Y4JwizDFB07R4R6R0/Ho8THmRQZFs2uNC8pt28NdrHvBfzOf30qS/bJjQUU+bLBA0+K5WijROjA9UQFwtrlUyqZsw+ecpw+E6ynVYNGHd836b9X5RyzOzf18Xl6IUHUVjy98msThBWvD40G8HXx8mIfcsb3WzOMWR9rLa9HGvaC5EyYg8+/Kz2gHPGDQsYzd9Yi3y92AFaqyhClMIwV2VtU+G1AztwGJ4ZV4gQTX9coKGQWhZlwRdzrECTfditer+BA9uhafWKL81tmeSnll0/JBBrOKEavo8l7FpvEJTTQt2C24O7borSNL++ACv7He3ZVUbXOeZo9FIH9ERzqvOJLULZCyU7V02n5TXfcQ6xziicYyOhyyfOPdMmsMzgDfxbSr+qlNpmNy9llhp612Pr4UF2JfUEzUZXl7Wuno1dTQ1r5ivaLKL5raxf9pKq2x2xsGrZgr16vbl9+c/126vN8t3d5vW7D8tXrcTG4DfqelbfWlVJQ27qga+a7kKOf2b781lv6os6i+/a0ikMyUOwi9lMmUSo3Piw+HP+13ww870hN0tx3lHGFjT6xUxT9tLoTO5KBzi1hpzdn51Rxvspp4nKQ1I6GR6r/YSVm3+BntfkkzozVaPrkrpSB1nA6LjpLc6w+BY/heCRABomFqfJ9Qop5nB2MSXweGgxEgdj1/dgoYh+THw+fT6dn5XaB5rayWeRfyF0J+sbGsKbQb5XyR7IQ3ti/0+fCrXEAjyEmVUCZ34sQiWLQ62gFd+fY2B/HCWZkOtw2AoPH5w6Hskcvxao06n0xK6d8J8o1o99S4wyqETWfsrgYFBSUKXIvXCyajepEKmASEkkCDquukro5uisGty/lOV02v6+vsN74SurqvaM
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/iuCntMk7XXDXd66rbsrsGXA2j1lQarYdKydLGmSnLUI8t9HWnZsw0Y3YAMON+wpDklR30d+kukDD2Ln+WLFbxLYgtvx9YSn4BMnbZBG8wW/y6VnoFNrpA7MQXAS9uCZFgV4KxJ8FHshldgqYFKzkAOrk7FEBKHMbvpR32RMsHsrHOhw365lmNs6s5cppBMmA/silWJK+lDlSXKp0u5OpU7BVS5vIZGZhJTFpFM+4caCEwT7JkXgOwgbGYFs2hQYhgvwbwBHxA+cfBge06BbEuvPJbhHPqwF1Nt1KGTOFOxLLpOcBXMq0AA7AXTwuZQOEF0mlIcJ90kOheCLAw+PllCY7SdIQi90RdCCp85gqZBikEgDl0Rzu1Y4JwizDFB07R4R6R0/Ho8THmRQZFs2uNC8pt28NdrHvBfzOf30qS/bJjQUU+bLBA0+K5WijROjA9UQFwtrlUyqZsw+ecpw+E6ynVYNGHd836b9X5RyzOzf18Xl6IUHUVjy98msThBWvD40G8HXx8mIfcsb3WzOMWR9rLa9HGvaC5EyYg8+/Kz2gHPGDQsYzd9Yi3y92AFaqyhClMIwV2VtU+G1AztwGJ4ZV4gQTX9coKGQWhZlwRdzrECTfditer+BA9uhafWKL81tmeSnll0/JBBrOKEavo8l7FpvEJTTQt2C24O7borSNL++ACv7He3ZVUbXOeZo9FIH9ERzqvOJLULZCyU7V02n5TXfcQ6xziicYyOhyyfOPdMmsMzgDfxbSr+qlNpmNy9llhp612Pr4UF2JfUEzUZXl7Wuno1dTQ1r5ivaLKL5raxf9pKq2x2xsGrZgr16vbl9+c/126vN8t3d5vW7D8tXrcTG4DfqelbfWlVJQ27qga+a7kKOf2b781lv6os6i+/a0ikMyUOwi9lMmUSo3Piw+HP+13ww870hN0tx3lHGFjT6xUxT9tLoTO5KBzi1hpzdn51Rxvspp4nKQ1I6GR6r/YSVm3+BntfkkzozVaPrkrpSB1nA6LjpLc6w+BY/heCRABomFqfJ9Qop5nB2MSXweGgxEgdj1/dgoYh+THw+fT6dn5XaB5rayWeRfyF0J+sbGsKbQb5XyR7IQ3ti/0+fCrXEAjyEmVUCZ34sQiWLQ62gFd+fY2B/HCWZkOtw2AoPH5w6Hskcvxao06n0xK6d8J8o1o99S4wyqETWfsrgYFBSUKXIvXCyajepEKmASEkkCDquukro5uisGty/lOV02v6+vsN74SurqvaM
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