Open Policy Agent (OPA) REST API API

Overview

OPA provides policy-based control for cloud native environments. The following *endpoints* (such as `PUT /v1/policies`) provide reference documentation for the OPA REST API. ### API specification viewing options - **[View the specification in *Redoc* (default)](index.html)** - **[View the specification in *Swagger UI*](swagger-ui.html)**

Open Policy Agent (OPA) REST API is an open data API from openpolicy.local. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 16 endpoints.

At a glance

Authentication

No auth

HTTPS

Yes

CORS

Unknown

Category

Open Data

Base URL

http://openpolicy.local

Version

0.28.0

Endpoints

16

OpenAPI

Specification ↗

Spec updated

2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "http://openpolicy.local/health" \
  -H "Accept: application/json"

const response = await fetch("http://openpolicy.local/health", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "http://openpolicy.local/health",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions