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/leIe1ZsJ3OBTW9Zm24GuhRo0ifPcGjqbF1HkSxJKQkM/e/D6Yclz0ZaoAOGFX2ycUfe3ffdR+q4hyh3AdIlLBRu0O9glUCGQXlykayBFO5zCgJN5iyZKDxGT1hhEEYWGJxUGISsJGm50SjIiJij6IIJJaPUdjf50yy2QooHJz2a+DDsFRSE87aiDLNEUBSPpLXQFGITR+Wks3Gm0mToG1dwqGhLmIk26AQSsA695LIXGaSww7imtpD1EAIScNLLAiN6Br4H9kEKbRhIgBj15xL9M5xygV26EYStt4V4zEnlItoDQSe1c4EeP5fkMYN0K3XABILKsZCQ7iE+O67Cbj6hikdLl1xaDNwZ5xliJAy8pTUPe6X3kmumiMXYHqIns4O6rhOIFDXbbvu6oK5XnC04a0Ib92o2459j6LdDE3qImQilUhjCttSaEytrInOY7kE6p0k1zZh+Chxh/5VgR606QTzyfRn2f0HlOXP40JELdQL4JAvH/mMwy0MJS+gOzVrCqk7O2DfQ62Z9Cat6VTdp5+ea9qvMBKPHEP+t9qD31p8S2Jq/sLfAEOQOIWlXcUUZnsZqrEMoMhF36CGBrfWFjK3ppytIoCBDRVlAOquTQ/TTbnX5ThwJoOHdS7i1d6XKDy27eVLYcpgwhx9aCsfWhYnojdR36Cv0Nz0pffO7C7Cx33POsTLGznOOXi/dgiPRHHg+oIWFqaSm0VUzanmH9zyGluf5bFb3Epq/cO6FsVFsbWmyH1L6XqU0NLv/KIvM8rfeRoFPNJbUCzB7Xc07Xb06dzX1qEVoYIu2mh/K+k6VdWh3W4totqXizdv13evfb/64Xt++v1+/ff/x9s0gsXPl9+p61d1aDaUxt93A10x3MYcUptXltJv+pkfTX6u39ptbeg0p5DG6dDrVVkmd2xDTn2e/zE5mv3fsFhlWqK0reARsI03Ea2u2tCs9ikeKuXi4uOCIDxPgySqgKj3F5yafdLT+C/n/in1ktrZpeEetL02kAs+OncGRwkwMSzQp5KEiPUyw106qHC+uJlw8ZWgiD8j+2FMnwPDbwJeTeWtyNsRCmlGwdzyD93P8EYFHte2HA/t/eil0Cov4FKdOSzJMQqOGfSegJVSXTGP3LEr+MZeyTnjRfr+RAT96Xddsbp8N3OqMAuMcRv0XaPu2R8VZLI3KhjdNJXXJixpJVtIT19bIMIEcZcYqWe67XdeKr5DRrpOLmKMcjt1vN/dQ138DDJ/5QA==
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/leIe1ZsJ3OBTW9Zm24GuhRo0ifPcGjqbF1HkSxJKQkM/e/D6Yclz0ZaoAOGFX2ycUfe3ffdR+q4hyh3AdIlLBRu0O9glUCGQXlykayBFO5zCgJN5iyZKDxGT1hhEEYWGJxUGISsJGm50SjIiJij6IIJJaPUdjf50yy2QooHJz2a+DDsFRSE87aiDLNEUBSPpLXQFGITR+Wks3Gm0mToG1dwqGhLmIk26AQSsA695LIXGaSww7imtpD1EAIScNLLAiN6Br4H9kEKbRhIgBj15xL9M5xygV26EYStt4V4zEnlItoDQSe1c4EeP5fkMYN0K3XABILKsZCQ7iE+O67Cbj6hikdLl1xaDNwZ5xliJAy8pTUPe6X3kmumiMXYHqIns4O6rhOIFDXbbvu6oK5XnC04a0Ib92o2459j6LdDE3qImQilUhjCttSaEytrInOY7kE6p0k1zZh+Chxh/5VgR606QTzyfRn2f0HlOXP40JELdQL4JAvH/mMwy0MJS+gOzVrCqk7O2DfQ62Z9Cat6VTdp5+ea9qvMBKPHEP+t9qD31p8S2Jq/sLfAEOQOIWlXcUUZnsZqrEMoMhF36CGBrfWFjK3ppytIoCBDRVlAOquTQ/TTbnX5ThwJoOHdS7i1d6XKDy27eVLYcpgwhx9aCsfWhYnojdR36Cv0Nz0pffO7C7Cx33POsTLGznOOXi/dgiPRHHg+oIWFqaSm0VUzanmH9zyGluf5bFb3Epq/cO6FsVFsbWmyH1L6XqU0NLv/KIvM8rfeRoFPNJbUCzB7Xc07Xb06dzX1qEVoYIu2mh/K+k6VdWh3W4totqXizdv13evfb/64Xt++v1+/ff/x9s0gsXPl9+p61d1aDaUxt93A10x3MYcUptXltJv+pkfTX6u39ptbeg0p5DG6dDrVVkmd2xDTn2e/zE5mv3fsFhlWqK0reARsI03Ea2u2tCs9ikeKuXi4uOCIDxPgySqgKj3F5yafdLT+C/n/in1ktrZpeEetL02kAs+OncGRwkwMSzQp5KEiPUyw106qHC+uJlw8ZWgiD8j+2FMnwPDbwJeTeWtyNsRCmlGwdzyD93P8EYFHte2HA/t/eil0Cov4FKdOSzJMQqOGfSegJVSXTGP3LEr+MZeyTnjRfr+RAT96Xddsbp8N3OqMAuMcRv0XaPu2R8VZLI3KhjdNJXXJixpJVtIT19bIMIEcZcYqWe67XdeKr5DRrpOLmKMcjt1vN/dQ138DDJ/5QA==
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