| client_id required | string Apache_Iceberg_REST_Catalog_API_BearerAuth Request Body schema: application/x-www-form-urlencodedrequired Any of | grant_type required | string Value: "client_credentials" | | scope | | | client_id required | string Client ID
+" class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA"> Client ID
This can be sent in the request body, but OAuth2 recommends sending it in a Basic Authorization header.
- | | client_secret required | string | client_secret required | string Client secret
+" class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA"> Client secret
This can be sent in the request body, but OAuth2 recommends sending it in a Basic Authorization header.
- | |
ResponsesServer URL when the port can be inferred from the scheme
- {scheme}://{host}/api/management/v1/v1/oauth/tokens Server URL when the port can be inferred from the scheme
- {scheme}://{host}/{basePath}/v1/oauth/tokens Generic base server URL, with all parts configurable
- {scheme}://{host}:{port}/{basePath}/v1/oauth/tokens Response samples Content typeapplication/json {"access_token": "string", "token_type": "bearer", "expires_in": 0, "issued_token_type": "urn:ietf:params:oauth:token-type:access_token", "refresh_token": "string", "scope": "string"
}List namespaces, optionally providing a parent namespace to list underneath List all namespaces at a certain level, optionally starting from a given parent namespace. If table accounting.tax.paid.info exists, using 'SELECT NAMESPACE IN accounting' would translate into GET /namespaces?parent=accounting and must return a namespace, ["accounting", "tax"] only. Using 'SELECT NAMESPACE IN accounting.tax' would translate into GET /namespaces?parent=accounting%1Ftax and must return a namespace, ["accounting", "tax", "paid"]. If parent is not provided, all top-level namespaces should be listed.
- Apache_Iceberg_REST_Catalog_API_OAuth2Apache_Iceberg_REST_Catalog_API_BearerAuth path Parameters| prefix required | string An optional prefix in the path
- |
query Parameters| pageToken | string or null (Apache_Iceberg_REST_Catalog_API_PageToken) Responses Server URL when the port can be inferred from the scheme
+ {scheme}://{host}/api/management/v1/v1/oauth/tokens Server URL when the port can be inferred from the scheme
+ {scheme}://{host}/{basePath}/v1/oauth/tokens Generic base server URL, with all parts configurable
+ {scheme}://{host}:{port}/{basePath}/v1/oauth/tokens Response samples Content typeapplication/json {"access_token": "string", "token_type": "bearer", "expires_in": 0, "issued_token_type": "urn:ietf:params:oauth:token-type:access_token", "refresh_token": "string", "scope": "string"
}List namespaces, optionally providing a parent namespace to list underneath List all namespaces at a certain level, optionally starting from a given parent namespace. If table accounting.tax.paid.info exists, using 'SELECT NAMESPACE IN accounting' would translate into GET /namespaces?parent=accounting and must return a namespace, ["accounting", "tax"] only. Using 'SELECT NAMESPACE IN accounting.tax' would translate into GET /namespaces?parent=accounting%1Ftax and must return a namespace, ["accounting", "tax", "paid"]. If parent is not provided, all top-level namespaces should be listed.
+ Apache_Iceberg_REST_Catalog_API_OAuth2Apache_Iceberg_REST_Catalog_API_BearerAuth path Parameters| prefix required | string An optional prefix in the path
+ |
query Parameters| pageToken | string or null (Apache_Iceberg_REST_Catalog_API_PageToken) An opaque token that allows clients to make use of pagination for list APIs (e.g. ListTables). Clients may initiate the first paginated request by sending an empty query parameter pageToken to the server.
+" class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA"> An opaque token that allows clients to make use of pagination for list APIs (e.g. ListTables). Clients may initiate the first paginated request by sending an empty query parameter pageToken to the server.
Servers that support pagination should identify the pageToken parameter and return a next-page-token in the response if there are more results available. After the initial request, the value of next-page-token from each response must be used as the pageToken parameter value for the next request. The server must return null value for the next-page-token in the last response.
Servers that support pagination must return all results in a single response with the value of next-page-token set to null if the query parameter pageToken is not set in the request.
Servers that do not support pagination should ignore the pageToken parameter and return all results in a single response. The next-page-token must be omitted from the response.
Clients must interpret either null or missing response value of next-page-token as the end of the listing results.
- | | pageSize | integer >= 1 For servers that support pagination, this signals an upper bound of the number of results that a client will receive. For servers that do not support pagination, clients may receive results larger than the indicated pageSize.
- | | parent | string Example: parent=accounting%1Ftax An optional namespace, underneath which to list namespaces. If not provided or empty, all top-level namespaces should be listed. If parent is a multipart namespace, the parts must be separated by the unit separator (0x1F) byte.
- |
Responses | | parent | string Example: parent=accounting%1Ftax An optional namespace, underneath which to list namespaces. If not provided or empty, all top-level namespaces should be listed. If parent is a multipart namespace, the parts must be separated by the unit separator (0x1F) byte.
+ |
ResponsesServer URL when the port can be inferred from the scheme
- {scheme}://{host}/api/management/v1/v1/{prefix}/namespaces Server URL when the port can be inferred from the scheme
- {scheme}://{host}/{basePath}/v1/{prefix}/namespaces Generic base server URL, with all parts configurable
- {scheme}://{host}:{port}/{basePath}/v1/{prefix}/namespaces Response samples Content typeapplication/json Example Create a namespace Create a namespace, with an optional set of properties. The server might also add properties, such as last_modified_time etc.
- Apache_Iceberg_REST_Catalog_API_OAuth2Apache_Iceberg_REST_Catalog_API_BearerAuth path Parameters| prefix required | string An optional prefix in the path
- |
Request Body schema: application/jsonrequired | namespace required | Array of strings (Apache_Iceberg_REST_Catalog_API_Namespace) Reference to one or more levels of a namespace
- | | object Default: {} Configured string to string map of properties for the namespace
- |
ResponsesServer URL when the port can be inferred from the scheme
+ {scheme}://{host}/api/management/v1/v1/{prefix}/namespaces Server URL when the port can be inferred from the scheme
+ {scheme}://{host}/{basePath}/v1/{prefix}/namespaces Generic base server URL, with all parts configurable
+ {scheme}://{host}:{port}/{basePath}/v1/{prefix}/namespaces Response samples Content typeapplication/json Example Create a namespace Create a namespace, with an optional set of properties. The server might also add properties, such as last_modified_time etc.
+ Apache_Iceberg_REST_Catalog_API_OAuth2Apache_Iceberg_REST_Catalog_API_BearerAuth path Parameters| prefix required | string An optional prefix in the path
+ |
Request Body schema: application/jsonrequired | namespace required | Array of strings (Apache_Iceberg_REST_Catalog_API_Namespace) Reference to one or more levels of a namespace
+ | | object Default: {} Configured string to string map of properties for the namespace
+ |
ResponsesServer URL when the port can be inferred from the scheme
- {scheme}://{host}/api/management/v1/v1/{prefix}/namespaces Server URL when the port can be inferred from the scheme
- {scheme}://{host}/{basePath}/v1/{prefix}/namespaces Generic base server URL, with all parts configurable
- {scheme}://{host}:{port}/{basePath}/v1/{prefix}/namespaces Request samples Content typeapplication/json Response samples - 200
- 400
- 401
- 403
- 406
- 409
- 419
- 503
- 5XX
Content typeapplication/json |
