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: eNrtV01v2zgQ/SsEz44/0hTY9S3bprsBWhdo0pPXcGhpZLGlSJak3ASG/3tnRMmSICFdYBdYtOjJ8sxw+N7MIzU68iD2ni/X/DaBHbg930x4Cj5x0gZpNF/y+1x6Bjq1RurAHAQn4QCeaVGAtyLBR3EQUomdAiY1CzmwOhlLRBDK7Kd/69uMCfZghQMdHtq1DHNbZw4yhXTCZGBfpVJMSR+qPEkuVdrdqdQpuMrlLSQyk5CymHTKJ9xYcIJg36YIfA9hKyOQbZsCw3AB/g3giPiRkw/DYxp0S2L9pQT3xIe1gHq7DoXMmYJ9zWWSs2DOBRpgJ4AOvpTSAaLLhPIw4T7JoRB8eeThyRIKs/sESeiFrgla8NQZLBVSDBJp4JJobtcK5wRhlgGKrt0jIr3np9NpwoMMimyrBheaN7Sbt0b7mPdyPqefPvVV24SGYsp8maDBZ6VStHFidKAa4mJhrZJJ1YzZJ08Zjv+QbKdVA8Yd3/dp/x+lHDP7D3VxOXrhURSW/H0y6zOENa8PzVbwzWkyYt/xRjfbBYZsTtW2V2NN+0OkjNiDD/9Ve8A544YFjObvrEW+XuwBrVUUIUphmKuytqnw2oE9OAzPjCtEiKYXl2gopJZFWfDlHCvQZB92q95v4MB2aFq95itzVyb5uWU3jwnEGk6ohh9iCbvWWwTltFB34A7gbpqiNM2vL8DKfk97dpXRdY45Gr3UAT3RnOt8ZotQDkLJzlXTaXnNd5xDrDMK59RI6OqZc8+0CSwzeAP/ktLPKqW22c1LmaWG3vXYeniUXUk9Q7PR1VWtq5djV1PDmvmKNotofinrp72k6nZHLKxatmSv32zvXv118+56u3p/v33z/uPqdSuxMfiNul7Wt1ZV0pCbeuCrpruQ45/ZYTHrTX1RZ/FdWzqFIXkIdjmbKZMIlRsflr/Nf58PZr635GYpzjvK2IJGv5hpyl4Zncl96QCn1pCzh4sLyvgw5TRReUhKJ8NTtZ+wcvsZ6HlDPqkzUzW6LqkrdZAFjI6b3uIMi2/xcwgeCaBhYnmeXK+RYg4Xl1MCj4cWI3Ewdn0PForox8SL6WIxnV+U2gca28lpsQCF0J20b2kKbyb5Xil7KI/tkf2RvhVqjQV4DDOrBA79WIRKF8daQmt+WGBgfx4lnZDreNwJDx+dOp3IHD8XqNWp9MSuHfGfKda/+5gYZVCprP2WwcmgpKBKkgfhZNVukiFSAZGSShB0XHWd0NXRWTW4gCnL+bj9eXOPF8M3OpT2uA==
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: eNrtV01v2zgQ/SsEz44/0hTY9S3bprsBWhdo0pPXcGhpZLGlSJak3ASG/3tnRMmSICFdYBdYtOjJ8sxw+N7MIzU68iD2ni/X/DaBHbg930x4Cj5x0gZpNF/y+1x6Bjq1RurAHAQn4QCeaVGAtyLBR3EQUomdAiY1CzmwOhlLRBDK7Kd/69uMCfZghQMdHtq1DHNbZw4yhXTCZGBfpVJMSR+qPEkuVdrdqdQpuMrlLSQyk5CymHTKJ9xYcIJg36YIfA9hKyOQbZsCw3AB/g3giPiRkw/DYxp0S2L9pQT3xIe1gHq7DoXMmYJ9zWWSs2DOBRpgJ4AOvpTSAaLLhPIw4T7JoRB8eeThyRIKs/sESeiFrgla8NQZLBVSDBJp4JJobtcK5wRhlgGKrt0jIr3np9NpwoMMimyrBheaN7Sbt0b7mPdyPqefPvVV24SGYsp8maDBZ6VStHFidKAa4mJhrZJJ1YzZJ08Zjv+QbKdVA8Yd3/dp/x+lHDP7D3VxOXrhURSW/H0y6zOENa8PzVbwzWkyYt/xRjfbBYZsTtW2V2NN+0OkjNiDD/9Ve8A544YFjObvrEW+XuwBrVUUIUphmKuytqnw2oE9OAzPjCtEiKYXl2gopJZFWfDlHCvQZB92q95v4MB2aFq95itzVyb5uWU3jwnEGk6ohh9iCbvWWwTltFB34A7gbpqiNM2vL8DKfk97dpXRdY45Gr3UAT3RnOt8ZotQDkLJzlXTaXnNd5xDrDMK59RI6OqZc8+0CSwzeAP/ktLPKqW22c1LmaWG3vXYeniUXUk9Q7PR1VWtq5djV1PDmvmKNotofinrp72k6nZHLKxatmSv32zvXv118+56u3p/v33z/uPqdSuxMfiNul7Wt1ZV0pCbeuCrpruQ45/ZYTHrTX1RZ/FdWzqFIXkIdjmbKZMIlRsflr/Nf58PZr635GYpzjvK2IJGv5hpyl4Zncl96QCn1pCzh4sLyvgw5TRReUhKJ8NTtZ+wcvsZ6HlDPqkzUzW6LqkrdZAFjI6b3uIMi2/xcwgeCaBhYnmeXK+RYg4Xl1MCj4cWI3Ewdn0PForox8SL6WIxnV+U2gca28lpsQCF0J20b2kKbyb5Xil7KI/tkf2RvhVqjQV4DDOrBA79WIRKF8daQmt+WGBgfx4lnZDreNwJDx+dOp3IHD8XqNWp9MSuHfGfKda/+5gYZVCprP2WwcmgpKBKkgfhZNVukiFSAZGSShB0XHWd0NXRWTW4gCnL+bj9eXOPF8M3OpT2uA==
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