Open Policy Agent

Open Policy Agent Query API

The Query API from Open Policy Agent — 1 operation(s) for query.

Documentation GitHub OpenAPI

Documentation

https://www.openpolicyagent.org/docs/latest/rest-api/#policy-api

https://www.openpolicyagent.org/docs/latest/rest-api/#data-api

https://www.openpolicyagent.org/docs/latest/rest-api/#query-api

https://www.openpolicyagent.org/docs/latest/rest-api/#compile-api

https://www.openpolicyagent.org/docs/latest/rest-api/#health-api

https://www.openpolicyagent.org/docs/latest/rest-api/#config-api

https://www.openpolicyagent.org/docs/latest/rest-api/#status-api

Specifications

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/openapi/open-policy-agent-query-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/json-schema/opa-policy-schema.json

Other Resources

BrunoCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/policy/bruno.json

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/ https://api-evangelist.postman.co/workspace/Open-Policy-Agentbcc99d6c-728a-4d86-83fd-b6495f5e8fb8/collection/35240-19ce2c88-97b8-4f58-a101-b8be70794a85

BrunoCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/data/bruno.json

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/ https://api-evangelist.postman.co/workspace/Open-Policy-Agentbcc99d6c-728a-4d86-83fd-b6495f5e8fb8/collection/35240-96c58dc4-3514-48ee-a35f-a9c2aeb14fa0

BrunoCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/query/bruno.json

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/ https://api-evangelist.postman.co/workspace/Open-Policy-Agentbcc99d6c-728a-4d86-83fd-b6495f5e8fb8/collection/35240-9170dd84-c3d5-45a4-9efc-9ef6ab30744e

BrunoCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/compile/bruno.json

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/ https://api-evangelist.postman.co/workspace/Open-Policy-Agentbcc99d6c-728a-4d86-83fd-b6495f5e8fb8/collection/35240-1e1d8e0e-7157-4b7f-99cf-611fa56a0c3c

BrunoCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/health/bruno.json

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/ https://api-evangelist.postman.co/workspace/Open-Policy-Agentbcc99d6c-728a-4d86-83fd-b6495f5e8fb8/collection/35240-198cdb4f-e1d1-44c4-aa1f-ef8f66760d1a

BrunoCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/config/bruno.json

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/ https://api-evangelist.postman.co/workspace/Open-Policy-Agentbcc99d6c-728a-4d86-83fd-b6495f5e8fb8/collection/35240-979cbaf7-8515-4fd2-8035-134685590967

BrunoCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/status/bruno.json

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/open-policy-agent/refs/heads/main/ https://api-evangelist.postman.co/workspace/Open-Policy-Agentbcc99d6c-728a-4d86-83fd-b6495f5e8fb8/collection/35240-b4943ca3-d651-4c68-a003-e6ca7feace03

OpenAPI Specification

openapi: 3.1.0
info:
  title: Compile Query API
  description: API for partially evaluating Rego queries in OPA (Open Policy Agent).
  version: 1.0.0
tags:
- name: Query
paths:
  /v1/query:
    get:
      summary: Execute an Ad-hoc Query (GET)
      description: Execute an ad-hoc query by providing the query as a URL parameter.
      parameters:
      - name: q
        in: query
        required: true
        description: Ad-hoc query to execute (URL encoded)
        schema:
          type: string
      - name: pretty
        in: query
        required: false
        description: Format response for human readability
        schema:
          type: boolean
      - name: explain
        in: query
        required: false
        description: Return query explanation
        schema:
          type: string
          enum:
          - notes
          - fails
          - full
          - debug
      - name: metrics
        in: query
        required: false
        description: Return query performance metrics
        schema:
          type: boolean
      responses:
        '200':
          description: Query executed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      type: object
        '400':
          description: Bad request
        '500':
          description: Server error
        '501':
          description: Streaming not implemented
      tags:
      - Query
    post:
      summary: Execute an Ad-hoc Query (POST)
      description: Execute an ad-hoc query by providing the query in the request body.
      requestBody:
        description: Query and optional input document in JSON format.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: Ad-hoc query to execute
                input:
                  type: object
                  description: Optional input document
      parameters:
      - name: pretty
        in: query
        required: false
        description: Format response for human readability
        schema:
          type: boolean
      - name: explain
        in: query
        required: false
        description: Return query explanation
        schema:
          type: string
          enum:
          - notes
          - fails
          - full
          - debug
      - name: metrics
        in: query
        required: false
        description: Return query performance metrics
        schema:
          type: boolean
      responses:
        '200':
          description: Query executed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      type: object
        '400':
          description: Bad request
        '500':
          description: Server error
        '501':
          description: Streaming not implemented
      tags:
      - Query