Open Policy Agent

Open Policy Agent Health API

The Health API from Open Policy Agent — 2 operation(s) for health.

Documentation GitHub OpenAPI

Operations 2

GET /health Health Check #

GET /health/{rule-name} Custom Health Check #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/open-policy-agent:open-policy-agent-health-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Health API
  description: API for checking the health and readiness of an OPA (Open Policy Agent) server.
  version: 1.0.0
tags:
- name: Health
paths:
  /health:
    get:
      summary: Health Check
      description: Perform a health check to verify that the server is operational.
      parameters:
      - name: bundles
        in: query
        required: false
        description: Include bundle activation status in the health check.
        schema:
          type: boolean
      - name: plugins
        in: query
        required: false
        description: Include plugin status in the health check.
        schema:
          type: boolean
      - name: exclude-plugin
        in: query
        required: false
        description: Exclude specific plugins from the health check. Can be specified multiple times.
        schema:
          type: string
      responses:
        '200':
          description: OPA service is healthy.
          content:
            application/json:
              schema:
                type: object
        '500':
          description: OPA service is not healthy.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message indicating the reason for failure.
      examples:
        healthy_response:
          summary: Healthy Response
          value: {}
        unhealthy_response:
          summary: Unhealthy Response
          value:
            error: not all plugins in OK state
      tags:
      - Health
      operationId: getHealth
      x-operation-id-source: derived
  /health/{rule-name}:
    get:
      summary: Custom Health Check
      description: Perform a custom health check using the policy at `data.system.health.`.
      parameters:
      - name: rule-name
        in: path
        required: true
        description: Name of the rule to evaluate in the `system.health` package.
        schema:
          type: string
      responses:
        '200':
          description: OPA service is healthy.
          content:
            application/json:
              schema:
                type: object
        '500':
          description: OPA service is not healthy.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message indicating the reason for failure.
      examples:
        healthy_response:
          summary: Healthy Response
          value: {}
        unhealthy_response:
          summary: Unhealthy Response
          value:
            error: health policy was not true at data.system.health.<rule-name>
      tags:
      - Health
      operationId: getHealthByRuleName
      x-operation-id-source: derived

Open Policy Agent Health API

Operations 2

Documentation

Specifications

Schemas & Data

Other Resources