v1

latestOpenAPI 3.0.32026-07-1761731.6 KB

Execute a policy given a batch of inputs

post/v1/batch/data/{path}

Path parameters

pathstring urlPath required

Example:app/rbac

The path separator is used to access values inside object and array documents. If the path indexes into an array, the server will attempt to convert the array index to an integer. If the path element cannot be converted to an integer, the server will respond with 404.

Query parameters

prettyboolean

If parameter is true, response will formatted for humans.

provenanceboolean

If parameter is true, response will include build/version info in addition to the result.

explain'notes' | 'fails' | 'full' | 'debug'

Return query explanation in addition to result.

metricsboolean

Return query performance metrics in addition to result.

instrumentboolean

Instrument query evaluation and return a superset of performance metrics in addition to result.

strict-builtin-errorsboolean

Treat built-in function call errors as fatal and return an error immediately.

Headers

Content-Encoding'gzip'

Indicates that the request body is gzip encoded

Accept-Encoding'gzip'

Indicates the server should respond with a gzip encoded body. The server will send the compressed response only if its length is above server.encoding.gzip.min_length value. See the configuration section

Request body

inputsobject required

Response

All batched policy executions succeeded. The server also returns 200 if the path refers to an undefined document. In this case, responses will be empty.

batch_decision_idstring

metricsobject

If query metrics are enabled, this field contains query performance metrics collected during the parse, compile, and evaluation steps.

responsesobject

Example response

{
  "batch_decision_id": "1bef6b7d-cd13-4890-bfe1-fd2e8de32189"
}