Linkerd

Linkerd Gateways API

Multicluster gateway metrics

GitHub OpenAPI

Operations 1

POST /api/v1/gateways Linkerd Get multicluster gateway metrics #

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-gateways-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-gateways-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-gateways-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Linkerd Viz Metrics Gateways 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: Gateways
  description: Multicluster gateway metrics
paths:
  /api/v1/gateways:
    post:
      operationId: getGateways
      summary: Linkerd Get multicluster gateway metrics
      description: Returns metrics for multicluster gateways including alive status, latency, and number of paired services.
      tags:
      - Gateways
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewaysRequest'
      responses:
        '200':
          description: Gateways response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewaysResponse'
        '500':
          description: Internal server error
components:
  schemas:
    GatewaysRequest:
      type: object
      properties:
        time_window:
          type: string
          default: 1m
        gateway_namespace:
          type: string
    GatewaysResponse:
      type: object
      properties:
        ok:
          type: object
          properties:
            gateways_table:
              type: object
              properties:
                rows:
                  type: array
                  items:
                    type: object
                    properties:
                      namespace:
                        type: string
                      name:
                        type: string
                      cluster_name:
                        type: string
                      paired_services:
                        type: integer
                      alive:
                        type: boolean
                      latency_ms_p50:
                        type: number
                      latency_ms_p95:
                        type: number
                      latency_ms_p99:
                        type: number
        error:
          type: object
          properties:
            error:
              type: string
externalDocs:
  description: Linkerd Viz CLI Reference
  url: https://linkerd.io/2-edge/reference/cli/viz/