openapi: 3.1.0
info:
  title: Envoy Proxy Admin Certificates Clusters API
  description: The Envoy Proxy Administration Interface provides a local HTTP-based management API for querying and modifying various aspects of the Envoy server at runtime. It serves as a critical operational tool for monitoring, debugging, and managing Envoy proxy instances. The admin interface typically runs on port 9901 by default. All mutation operations must be sent as HTTP POST requests; GET requests will not perform changes. Note that this endpoint is not authenticated, so access should be restricted in production environments.
  version: 1.38.0
  contact:
    name: Envoy Proxy
    url: https://www.envoyproxy.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:9901
  description: Default Envoy Admin Interface
tags:
- name: Clusters
  description: Cluster management and information endpoints.
paths:
  /clusters:
    get:
      operationId: getClusters
      summary: Envoy Proxy Get Cluster Information
      description: Lists all configured cluster manager clusters including all discovered upstream hosts in each cluster along with per-host statistics. Provides information about the health status and connection metrics of upstream hosts.
      parameters:
      - name: format
        in: query
        description: Output format for cluster information.
        schema:
          type: string
          enum:
          - json
      responses:
        '200':
          description: Successful response with cluster information.
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: object
      tags:
      - Clusters