openapi: 3.1.0
info:
  title: Linkerd Proxy Admin Discovery Lifecycle API
  description: The Linkerd proxy exposes an admin HTTP server on each meshed pod, providing health check endpoints, readiness probes, Prometheus-compatible metrics, and runtime diagnostic information. By default this server listens on port 4191.
  version: 2.x
  contact:
    name: Linkerd
    url: https://linkerd.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:4191
  description: Linkerd proxy admin server (default port)
tags:
- name: Lifecycle
  description: Proxy lifecycle management endpoints
paths:
  /shutdown:
    post:
      operationId: shutdownProxy
      summary: Linkerd Initiate proxy shutdown
      description: Triggers a graceful shutdown of the Linkerd proxy. This endpoint is used during pod termination to ensure the proxy drains connections before exiting.
      tags:
      - Lifecycle
      responses:
        '200':
          description: Shutdown initiated
          content:
            text/plain:
              schema:
                type: string
externalDocs:
  description: Linkerd Proxy Configuration Reference
  url: https://linkerd.io/2-edge/reference/proxy-configuration/