openapi: 3.1.0
info:
  title: Kyverno Policy Reporter ClusterPolicyReports Health API
  description: The Kyverno Policy Reporter REST API provides endpoints for querying PolicyReport and ClusterPolicyReport custom resources generated by Kyverno. It exposes policy results, status counts, and resource-level violation data, serving as the backend for the Policy Reporter UI. The API enables programmatic access to policy compliance status across namespaces and clusters.
  version: 2.0.0
  contact:
    name: Kyverno Community
    url: https://kyverno.io/community/
  termsOfService: https://kyverno.io/
servers:
- url: http://localhost:8080
  description: Default Policy Reporter server
tags:
- name: Health
  description: Health and readiness endpoints
paths:
  /healthz:
    get:
      operationId: getHealthz
      summary: Kyverno Health check
      description: Returns the health status of the Policy Reporter server. Used by Kubernetes liveness and readiness probes to confirm the server is operational.
      tags:
      - Health
      responses:
        '200':
          description: Policy Reporter is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
        '503':
          description: Policy Reporter is not healthy
components:
  schemas:
    HealthStatus:
      type: object
      properties:
        status:
          type: string
          description: Health status of the server
          example: ok
externalDocs:
  description: Policy Reporter API Reference
  url: https://kyverno.github.io/policy-reporter/core/api-reference/