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: eJztV99v2zYQ/leIe1ZsJ0uHTW9Zm24GOhdo0ifPcGjqbF1HkSxJOQkE/e/F6Yclz0Y6YAOGFX2ycUfe3ffdR+pYQZS7AOkS5go36HewSiDDoDy5SNZACvc5BYEmc5ZMFB6jJ9xjEEYWGJxUGITcS9Jyo1GQETFH0QUTSkap7W7yh5lvhRQPTno08WHYKygI5+2eMswSQVE8ktZCU4hNHJWTzsaZSpOhb1zBoaItYSbaoBNIwDr0ksueZ5DCDuOa2kLWQwhIwEkvC4zoGXgF7IMU2jCQADHqzyX6ZzjlArt0IwhbbwvxmJPKRbQHgk5q5wI9fi7JYwbpVuqACQSVYyEhrSA+O67Cbj6hikdLl1xaDNwZ5xliJAy8pTUPe6X3kmumiMXYHqIns4O6rhOIFDXbFn1dUNcrzhacNaGNezWb8c8x9MXQhB5iJkKpFIawLbXmxMqayBymFUjnNKmmGdNPgSNUfxPsqFUniEe+r8P+L6g8Zw4fOnKhTgCfZOHYfwxmeShhCd2hWUtY1ckZ+wZ63awvYVWv6ibt9bmm/SIzwegxxH+rPei99acEtuav7C0wBLlDSNpVXFGGp7Ea6xCKTMQdekhga30hY2v64QoSKMhQURaQzurkEP20W12+E0cCaHj3Ehb2rlT5oWW3TwpbDhPm8ENL4dg6NxG9kfoO/R79bU9K3/zuAmzs95xzrIyx85yj10u34Eg0B54PaGFu9lLT6KoZtbzDex5Dy/P1bFb3Erp+4dwLY6PY2tJk36X0rUppaHb/URaZ5W+9jQKfaCypF2D2urrudPXq3NXUoxahgS3aar4r6xtV1qHdbS2i2ZaKN2/Xd69/u/39Zr14f79++/7j4s0gsXPl9+p61d1aDaUxt93A10x3MYcUpvvLaTf9TY+mv1Zv7Te39BpSyGN06XSqrZI6tyGmP81+np3Mfu/YLTLco7au4BGwjTQRr63Z0q70KB4p5uLh4oIjPkyAJ6uAqvQUn5t80tH6T+T/K/aR2dqm4R21vjSRCjw7dgZHCjMxLNGkkIeK9DDB3jipcry4mnDxlKGJPCD7Y0+dAMNvA19OfpzMLkoTIk/v7HM2xEKaUdR3PIz3A/0Rk0dFVsPJ/T89GTqpRXyKU6clGSahkUXVKWkJ+0vms3sfJX8ZUFkwvKiqNjLgR6/rms3t+4F7nlFgnMPM/wJt/+x1cRZLI7fhcbOXuuRFjTb30lPTeNZjAjnKjOWyrLpdN4rvktGukxuZoxzO36+391DXXwDNpPzN
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/iceberg/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: eJztV99v2zYQ/leIe1ZsJ0uHTW9Zm24GOhdo0ifPcGjqbF1HkSxJOQkE/e/F6Yclz0Y6YAOGFX2ycUfe3ffdR+pYQZS7AOkS5go36HewSiDDoDy5SNZACvc5BYEmc5ZMFB6jJ9xjEEYWGJxUGITcS9Jyo1GQETFH0QUTSkap7W7yh5lvhRQPTno08WHYKygI5+2eMswSQVE8ktZCU4hNHJWTzsaZSpOhb1zBoaItYSbaoBNIwDr0ksueZ5DCDuOa2kLWQwhIwEkvC4zoGXgF7IMU2jCQADHqzyX6ZzjlArt0IwhbbwvxmJPKRbQHgk5q5wI9fi7JYwbpVuqACQSVYyEhrSA+O67Cbj6hikdLl1xaDNwZ5xliJAy8pTUPe6X3kmumiMXYHqIns4O6rhOIFDXbFn1dUNcrzhacNaGNezWb8c8x9MXQhB5iJkKpFIawLbXmxMqayBymFUjnNKmmGdNPgSNUfxPsqFUniEe+r8P+L6g8Zw4fOnKhTgCfZOHYfwxmeShhCd2hWUtY1ckZ+wZ63awvYVWv6ibt9bmm/SIzwegxxH+rPei99acEtuav7C0wBLlDSNpVXFGGp7Ea6xCKTMQdekhga30hY2v64QoSKMhQURaQzurkEP20W12+E0cCaHj3Ehb2rlT5oWW3TwpbDhPm8ENL4dg6NxG9kfoO/R79bU9K3/zuAmzs95xzrIyx85yj10u34Eg0B54PaGFu9lLT6KoZtbzDex5Dy/P1bFb3Erp+4dwLY6PY2tJk36X0rUppaHb/URaZ5W+9jQKfaCypF2D2urrudPXq3NXUoxahgS3aar4r6xtV1qHdbS2i2ZaKN2/Xd69/u/39Zr14f79++/7j4s0gsXPl9+p61d1aDaUxt93A10x3MYcUpvvLaTf9TY+mv1Zv7Te39BpSyGN06XSqrZI6tyGmP81+np3Mfu/YLTLco7au4BGwjTQRr63Z0q70KB4p5uLh4oIjPkyAJ6uAqvQUn5t80tH6T+T/K/aR2dqm4R21vjSRCjw7dgZHCjMxLNGkkIeK9DDB3jipcry4mnDxlKGJPCD7Y0+dAMNvA19OfpzMLkoTIk/v7HM2xEKaUdR3PIz3A/0Rk0dFVsPJ/T89GTqpRXyKU6clGSahkUXVKWkJ+0vms3sfJX8ZUFkwvKiqNjLgR6/rms3t+4F7nlFgnMPM/wJt/+x1cRZLI7fhcbOXuuRFjTb30lPTeNZjAjnKjOWyrLpdN4rvktGukxuZoxzO36+391DXXwDNpPzN
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/iceberg/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