Linkerd Health API

openapi: 3.1.0
info:
  title: Linkerd Proxy Admin Discovery Health 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: Health
  description: Health and readiness check endpoints
paths:
  /ready:
    get:
      operationId: getProxyReadiness
      summary: Linkerd Proxy readiness check
      description: Returns the readiness status of the Linkerd proxy. Used by Kubernetes as a readiness probe to determine if the proxy is ready to accept traffic.
      tags:
      - Health
      responses:
        '200':
          description: Proxy is ready
          content:
            text/plain:
              schema:
                type: string
        '503':
          description: Proxy is not ready
  /live:
    get:
      operationId: getProxyLiveness
      summary: Linkerd Proxy liveness check
      description: Returns the liveness status of the Linkerd proxy. Used by Kubernetes as a liveness probe to determine if the proxy process is alive.
      tags:
      - Health
      responses:
        '200':
          description: Proxy is alive
          content:
            text/plain:
              schema:
                type: string
externalDocs:
  description: Linkerd Proxy Configuration Reference
  url: https://linkerd.io/2-edge/reference/proxy-configuration/