Get Applicable policies for catalog, namespace, table, or views

get

{scheme}://{host}/{basePath}/polaris/v1/{prefix}/applicable-policies

Retrieves all applicable policies for a specified entity, including inherited policies from parent entities. An entity can be a table/view, namespace, or catalog. The required parameters depend on the entity type:

Table/View:
- The namespace parameter is required to specify the entity's namespace.
- The target-name parameter is required to specify the entity name.
Namespace:
- The namespace parameter is required to specify the identifier.
- The target-name parameter should not be set.
Catalog:
- Neither namespace nor target-name should be set.

An optional policyType parameter filters results to return only policies of the specified type.

This API evaluates the entity's hierarchy and applies inheritable policies from parent entities. The inheritance follows the following override rule:

Table-like level policies override namespace and catalog policies.
Namespace-level policies override upper level namespace or catalog policies.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

prefix

string

required

An optional prefix in the path

Query Params

pageToken

string | null

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.

namespace

string

A namespace identifier as a single string. Multipart namespace parts should be separated by the unit separator (0x1F) byte.

target-name

string

Name of the target table/view

policyType

string | null

The type of a policy

Responses

200A list of policies applicable to the table

400Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

401Unauthorized. The REST Catalog SHOULD respond with the 401 UnauthorizedResponse when the access token provided is expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the request.

403Forbidden. Authenticated user does not have the necessary permissions.

404Not Found - NoSuchTableException, target table does not exist - NoSuchViewException, target view does not exist - NoSuchNamespaceException, target namespace does not exist

503The service is not ready to handle the request, request could have been partially processed. The service may additionally send a Retry-After header to indicate when to retry, a non idempotent request should only be retried by the client when the Retry-After header is present.

5XXA server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.