Envoy Proxy Debugging API

openapi: 3.1.0
info:
  title: Envoy Proxy Admin Certificates Debugging 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: Debugging
  description: Debugging and traffic inspection endpoints.
paths:
  /tap:
    post:
      operationId: postTap
      summary: Envoy Proxy Tap Traffic
      description: Installs a traffic tap configuration that allows inspecting traffic matching specific filter rules. The tap configuration is supplied in the request body.
      requestBody:
        description: Tap configuration in JSON or YAML format.
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Tap configuration installed and streaming tap results.
          content:
            application/json:
              schema:
                type: object
      tags:
      - Debugging
  /contention:
    get:
      operationId: getContention
      summary: Envoy Proxy Get Mutex Contention Stats
      description: Dumps current Envoy mutex contention stats in JSON format, if mutex tracing is enabled.
      responses:
        '200':
          description: Successful response with contention statistics.
          content:
            application/json:
              schema:
                type: object
      tags:
      - Debugging