Linkerd

Linkerd Health API

Health and readiness check endpoints

GitHub OpenAPI

Operations 2

GET /ready Linkerd Proxy readiness check #
GET /live Linkerd Proxy liveness check #

Documentation

📖
Documentation
https://linkerd.io/2-edge/reference/proxy-configuration/
📖
Documentation
https://linkerd.io/2-edge/reference/cli/viz/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/linkerd/refs/heads/main/openapi/linkerd-health-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/linkerd/refs/heads/main/json-schema/stat-summary.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/linkerd/refs/heads/main/json-schema/edge.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/linkerd/refs/heads/main/json-schema/gateway.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/linkerd/refs/heads/main/json-schema/tap-event.json

Other Resources

🔗
Reference
https://linkerd.io/2-edge/reference/proxy-metrics/
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/linkerd/refs/heads/main/json-ld/linkerd-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/linkerd-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

linkerd-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Linkerd Health API
  version: 2.x
  contact:
    name: Linkerd
    url: https://linkerd.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: 'Operations tagged Health across 2 of this provider''s published API definitions: linkerd-proxy-admin-openapi.yml, linkerd-viz-metrics-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:4191
  description: Linkerd proxy admin server (default port)
- url: http://metrics-api.linkerd-viz.svc.cluster.local:8085
  description: Linkerd Viz Metrics API service (in-cluster)
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
    servers:
    - url: http://localhost:4191
      description: Linkerd proxy admin server (default port)
  /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
    servers:
    - url: http://localhost:4191
      description: Linkerd proxy admin server (default port)
x-refined-from:
- linkerd-proxy-admin-openapi.yml
- linkerd-viz-metrics-openapi.yml