Linkerd

Linkerd Routes API

Per-route metrics

GitHub OpenAPI

Operations 1

POST /api/v1/top-routes Linkerd Get top routes for a resource #

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-routes-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-routes-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-routes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Linkerd Viz Metrics Routes API
  description: The Linkerd Viz extension provides a metrics API that powers the linkerd viz CLI commands and the Linkerd dashboard. It queries Prometheus for golden metrics including request volume, success rate, and latency distributions for HTTP, HTTP/2, and gRPC traffic across meshed workloads.
  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://metrics-api.linkerd-viz.svc.cluster.local:8085
  description: Linkerd Viz Metrics API service (in-cluster)
tags:
- name: Routes
  description: Per-route metrics
paths:
  /api/v1/top-routes:
    post:
      operationId: getTopRoutes
      summary: Linkerd Get top routes for a resource
      description: Returns per-route metrics for the specified resource. Requires a ServiceProfile to be defined for the service receiving requests. This powers the linkerd viz routes command.
      tags:
      - Routes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TopRoutesRequest'
      responses:
        '200':
          description: Top routes response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopRoutesResponse'
        '500':
          description: Internal server error
components:
  schemas:
    RouteTable:
      type: object
      properties:
        rows:
          type: array
          items:
            type: object
            properties:
              route:
                type: string
              time_window:
                type: string
              authority:
                type: string
              stats:
                $ref: '#/components/schemas/BasicStats'
    TopRoutesRequest:
      type: object
      properties:
        resource_type:
          type: string
        resource_name:
          type: string
        namespace:
          type: string
        time_window:
          type: string
          default: 1m
      required:
      - resource_type
    TopRoutesResponse:
      type: object
      properties:
        ok:
          type: object
          properties:
            routes:
              type: array
              items:
                $ref: '#/components/schemas/RouteTable'
        error:
          type: object
          properties:
            error:
              type: string
    BasicStats:
      type: object
      properties:
        success_count:
          type: integer
          format: int64
        failure_count:
          type: integer
          format: int64
        latency_ms_p50:
          type: number
          format: double
        latency_ms_p95:
          type: number
          format: double
        latency_ms_p99:
          type: number
          format: double
        actual_success_count:
          type: integer
          format: int64
        actual_failure_count:
          type: integer
          format: int64
externalDocs:
  description: Linkerd Viz CLI Reference
  url: https://linkerd.io/2-edge/reference/cli/viz/