Other

Open Policy Agent (OPA) REST

auto-generated

swirls add openpolicy …

actionPOSTv1.0.0

Compile

This API endpoint allows you to partially evaluate Rego queries and obtain a simplified version of the policy. The example below assumes that OPA has been given the following policy (use `PUT /v1/policies/{path}`): ```yaml package example allow { input.subject.clearance_level >= data.reports[_].clearance_level } ``` Compile API **request body** so that it contain the following fields: | Field | Type | Required | Description | | --- | --- | --- | --- | | `query` | `string` | Yes | The query to partially evaluate and compile. | | `input` | `any` | No | The input document to use during partial evaluation (default: undefined). | | `unknowns` | `array[string]` | No | The terms to treat as unknown during partial evaluation (default: `["input"]`]). | For example: ```json { "query": "data.example.allow == true", "input": { "subject": { "clearance_level": 4 } }, "unknowns": [ "data.reports" ] } ``` ### Partial evaluation In some cases, the result of partial valuation is a conclusive, unconditional answer. See [the guidance](https://www.openpolicyagent.org/docs/latest/rest-api/#unconditional-results-from-partial-evaluation) for details.

Source

actionPUTv1.0.0

Create or overwrite a document

If the path does not refer to an existing document (for example *us-west/servers*), the server will attempt to create all the necessary containing documents. This behavior is similar to the Unix command [mkdir -p](https://en.wikipedia.org/wiki/Mkdir#Options).

Source

actionPUTv1.0.0

Create or update a policy module

- If the policy module does not exist, it is created. - If the policy module already exists, it is replaced. If the policy module isn't correctly defined, a *bad request* (400) response is returned. ### Example policy module ```yaml package opa.examples import data.servers import data.networks import data.ports public_servers[server] { some k, m server := servers[_] server.ports[_] == ports[k].id ports[k].networks[_] == networks[m].id networks[m].public == true } ```

Source

actionDELETEv1.0.0

Delete a document

This API endpoint deletes an existing document from the server

Source

actionDELETEv1.0.0

Delete a policy module

This API endpoint removes an existing policy module from the server

Source

actionPOSTv1.0.0

Execute a simple query

This API queries the document at */data/system/main* by default (however, you can [configure OPA](https://www.openpolicyagent.org/docs/latest/configuration/) to use a different path to serve these queries). That document defines the response. For example, use the following in `PUT /v1/policies/{path}`) to define a rule that will produce a value for the */data/system/main* document: ```yaml package system main = msg { msg := sprintf("hello, %v", input.user) } ``` The server will return a *not found* (404) response if */data/system/main* is undefined.

Source

actionPOSTv1.0.0

Execute an ad-hoc query (complex)

This API endpoint returns bindings for the variables in the query. For simpler JSON queries, you may use `GET /v1/query` instead.

Source

actionGETv1.0.0

Execute an ad-hoc query (simple)

This API endpoint returns bindings for the variables in the query. For more complex JSON queries, use `POST /v1/query` instead.

Source

actionGETv1.0.0

Get a document

This API endpoint returns the document specified by `path`. The server will return a *bad request* (400) response if either: - The query requires an input document and you do not provide it - You provide the input document but the query has already defined it.

Source

actionPOSTv1.0.0

Get a document (with input)

The server will return a *bad request* (400) response if either: - The query requires an input document and you do not provide it - You provided an input document but the query has already defined it. If `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, a *not found* response (404) will be returned.

Source

actionGETv1.0.0

Get a policy module

This API endpoint returns the details of the specified policy module (`{id}`)

Source

actionGETv1.0.0

Get configurations

This API endpoint responds with active configuration (result response) --- **Note** The `credentials` field in the `services` configuration and The `private_key` and `key` fields in the `keys` configuration will be omitted from the API response ---

Source

actionGETv1.0.0

List policies

This API endpoint responds with a list of all policy modules on the server (result response)

Source

actionPATCHv1.0.0

Update a document

This API endpoint updates an existing document on the server by describing the changes required (using [JSON patch operations](http://jsonpatch.com/))

Source

Beyond the catalog

Any provider, on request.

Request it

Tell us which provider you need, and we will ship it in the registry.

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

Request a provider Read the actions docs

acme · integrations

registry · live

terminal

~/acme $swirls add linear

✓ 12 typed actions · scopes and schemas included

~/acme $swirls add https://api.acme.dev/openapi.json

◆ Fetched spec · 38 operations

✓ 6 typed actions · generated from spec