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/iuCntMk7XXAXd66rdsK7DJg7Z6yIFVsOtZOljRJzloE+e8jLTu2YaMbsAHDDXuKQ1LU95GfZPrAg9h5vljxmwS24HZ8PeEp+MRJG6TRfMHvcukZ6NQaqQNzEJyEPXimRQHeigQfxV5IJbYKmNQs5MDqZCwRQSizm37UNxkT7N4KBzrct2sZ5rbO7GUK6YTJwL5IpZiSPlR5klyqtLtTqVNwlctbSGQmIWUx6ZRPuLHgBMG+SRH4DsJGRiCbNgWG4QL8G8AR8QMnH4bHNOiWxPpzCe6RD2sB9XYdCpkzBfuSyyRnwZwKNMBOAB18LqUDRJcJ5WHCfZJDIfjiwMOjJRRm+wmS0AtdEbTgqTNYKqQYJNLAJdHcrhXOCcIsAxRdu0dEesePx+OEBxkU2ZYNLjSvaTdvjfYx78V8Tj996su2CQ3FlPkyQYPPSqVo48ToQDXExcJaJZOqGbNPnjIcvpNsp1UDxh3ft2n/ilKOmf37urgcvfAgCkv+PpnVCcKK14dmI/j6OBmxb3mjm805hqyP1baXY017LlJG7MGHn9UecM64YQGj+Rtrka8XO0BrFUWIUhjmqqxtKrx2YAcOwzPjChGi6a8LNBRSy6Is+GKOFWiyD7tV7zdwYDs0rV7xpbktk/zUsuuHBGINJ1TD97GEXesNgnJaqFtwe3DXTVGa5tcXYGW/oz27yug6xxyNXuqAnmhOdT6xRSh7oWTnqum0vOY7ziHWGYVzbCR0+cS5Z9oElhm8gf9I6XeVUtvs5qXMUkPvemw9PMiupJ6g2ejqstbVs7GrqWHNfEWbRTR/lPXbXlJ1uyMWVi1bsJevNrcv3lz/e7VZvrvbvHr3YfmyldgY/EZdz+pbqyppyE098FXTXcjxz2x/PutNfVFn8V1bOoUheQh2MZspkwiVGx8Wf8//mQ9mvrfkZinOO8rYgka/mGnKXhidyV3pAKfWkLP7szPKeD/lNFF5SEonw2O1n7By8x/Q85p8UmemanRdUlfqIAsYHTe9xRkW3+KnEDwSQMPE4jS5XiHFHM4upgQeDy1G4mDs+h4sFNGPic+nl9FkkXYhdCfZW5q9m/m9V8AetkN7UP9PXwi1sgI8hJlVAkd9LEKlhkMtnBXfn2NgfwoldZDrcNgKDx+cOh7JHD8SqMGp9MSuHeyfKNaPfUKMMqi01X7B4DxQUlAlxL1wkrBV4kMqIFLSBoKOq64SujA6qwbXLmU5HbLX13d4HXwFKSfy/w==
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/iuCntMk7XXAXd66rdsK7DJg7Z6yIFVsOtZOljRJzloE+e8jLTu2YaMbsAHDDXuKQ1LU95GfZPrAg9h5vljxmwS24HZ8PeEp+MRJG6TRfMHvcukZ6NQaqQNzEJyEPXimRQHeigQfxV5IJbYKmNQs5MDqZCwRQSizm37UNxkT7N4KBzrct2sZ5rbO7GUK6YTJwL5IpZiSPlR5klyqtLtTqVNwlctbSGQmIWUx6ZRPuLHgBMG+SRH4DsJGRiCbNgWG4QL8G8AR8QMnH4bHNOiWxPpzCe6RD2sB9XYdCpkzBfuSyyRnwZwKNMBOAB18LqUDRJcJ5WHCfZJDIfjiwMOjJRRm+wmS0AtdEbTgqTNYKqQYJNLAJdHcrhXOCcIsAxRdu0dEesePx+OEBxkU2ZYNLjSvaTdvjfYx78V8Tj996su2CQ3FlPkyQYPPSqVo48ToQDXExcJaJZOqGbNPnjIcvpNsp1UDxh3ft2n/ilKOmf37urgcvfAgCkv+PpnVCcKK14dmI/j6OBmxb3mjm805hqyP1baXY017LlJG7MGHn9UecM64YQGj+Rtrka8XO0BrFUWIUhjmqqxtKrx2YAcOwzPjChGi6a8LNBRSy6Is+GKOFWiyD7tV7zdwYDs0rV7xpbktk/zUsuuHBGINJ1TD97GEXesNgnJaqFtwe3DXTVGa5tcXYGW/oz27yug6xxyNXuqAnmhOdT6xRSh7oWTnqum0vOY7ziHWGYVzbCR0+cS5Z9oElhm8gf9I6XeVUtvs5qXMUkPvemw9PMiupJ6g2ejqstbVs7GrqWHNfEWbRTR/lPXbXlJ1uyMWVi1bsJevNrcv3lz/e7VZvrvbvHr3YfmyldgY/EZdz+pbqyppyE098FXTXcjxz2x/PutNfVFn8V1bOoUheQh2MZspkwiVGx8Wf8//mQ9mvrfkZinOO8rYgka/mGnKXhidyV3pAKfWkLP7szPKeD/lNFF5SEonw2O1n7By8x/Q85p8UmemanRdUlfqIAsYHTe9xRkW3+KnEDwSQMPE4jS5XiHFHM4upgQeDy1G4mDs+h4sFNGPic+nl9FkkXYhdCfZW5q9m/m9V8AetkN7UP9PXwi1sgI8hJlVAkd9LEKlhkMtnBXfn2NgfwoldZDrcNgKDx+cOh7JHD8SqMGp9MSuHeyfKNaPfUKMMqi01X7B4DxQUlAlxL1wkrBV4kMqIFLSBoKOq64SujA6qwbXLmU5HbLX13d4HXwFKSfy/w==
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