Envoy

Envoy Clusters API

Upstream cluster inspection and status endpoints

GitHub OpenAPI

Operations 1

GET /clusters Envoy Get upstream cluster information #

Documentation

📖
Documentation
https://www.envoyproxy.io/docs/envoy/latest/operations/admin
📖
Documentation
https://aigateway.envoyproxy.io/docs/
📖
GettingStarted
https://aigateway.envoyproxy.io/docs/getting-started/basic-usage/

Specifications

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

SDKs

📦
GitHubRepository
https://github.com/envoyproxy/ai-gateway

Other Resources

🔗
Reference
https://aigateway.envoyproxy.io/docs/api/
🔗
ChangeLog
https://aigateway.envoyproxy.io/release-notes/

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/envoy-clusters-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

envoy-clusters-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Envoy Clusters API
  version: 1.31.0
  description: 'Operations tagged Clusters across 2 of this provider''s published API definitions: envoy-admin-api-openapi.yml, envoy-admin-api-openapi_2.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:9901
  description: Default Envoy Admin Interface
tags:
- name: Clusters
  description: Upstream cluster inspection and status endpoints
paths:
  /clusters:
    get:
      operationId: getClusters
      summary: Envoy Get upstream cluster information
      description: Returns information about all configured upstream clusters including host addresses, health status, statistics counters and gauges, and load balancing weights. Supports JSON or text output format.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Cluster information retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClustersResponse'
            text/plain:
              schema:
                type: string
    servers:
    - url: http://localhost:9901
      description: Default Envoy Admin Interface
components:
  schemas:
    ClusterStatus:
      type: object
      description: Status of an individual upstream cluster
      properties:
        name:
          type: string
          description: Cluster name
        added_via_api:
          type: boolean
          description: Whether the cluster was dynamically added via xDS API
        success_rate_ejection_threshold:
          type: number
          description: Success rate outlier detection ejection threshold as a percentage
        host_statuses:
          type: array
          description: Status of individual hosts within the cluster
          items:
            $ref: '#/components/schemas/HostStatus'
    HostStatus:
      type: object
      description: Status of an individual upstream host within a cluster
      properties:
        address:
          type: object
          description: Network address of the host
          properties:
            socket_address:
              type: object
              properties:
                address:
                  type: string
                  description: IP address or hostname
                port_value:
                  type: integer
                  description: Port number
        stats:
          type: array
          description: Statistics for this host
          items:
            type: object
            properties:
              name:
                type: string
                description: Stat name
              value:
                type: string
                description: Stat value
              type:
                type: string
                description: Stat type (Counter, Gauge, Histogram)
        health_status:
          type: object
          description: Current health status of this host
          properties:
            eds_health_status:
              type: string
              description: Health status as reported by EDS
              enum:
              - HEALTHY
              - UNHEALTHY
              - DRAINING
              - TIMEOUT
              - DEGRADED
            failed_active_health_check:
              type: boolean
              description: Whether active health checking has marked this host unhealthy
            failed_outlier_check:
              type: boolean
              description: Whether outlier detection has ejected this host
        weight:
          type: integer
          description: Load balancing weight for this host
        locality:
          type: object
          description: Geographic locality of this host
          properties:
            region:
              type: string
            zone:
              type: string
            sub_zone:
              type: string
    ClustersResponse:
      type: object
      description: Information about all configured upstream clusters
      properties:
        cluster_statuses:
          type: array
          description: List of cluster status objects
          items:
            $ref: '#/components/schemas/ClusterStatus'
    ClusterStatus_2:
      type: object
      description: Status of an individual upstream cluster
      properties:
        name:
          type: string
          description: Cluster name
        added_via_api:
          type: boolean
          description: Whether the cluster was added via xDS API
        success_rate_ejection_threshold:
          type: number
          description: Success rate ejection threshold percentage
        host_statuses:
          type: array
          items:
            $ref: '#/components/schemas/HostStatus_2'
    HostStatus_2:
      type: object
      description: Status of an individual host within a cluster
      properties:
        address:
          type: object
          properties:
            socket_address:
              type: object
              properties:
                address:
                  type: string
                port_value:
                  type: integer
        stats:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string
              type:
                type: string
        health_status:
          type: object
          properties:
            eds_health_status:
              type: string
              enum:
              - HEALTHY
              - UNHEALTHY
              - DRAINING
              - TIMEOUT
              - DEGRADED
            failed_active_health_check:
              type: boolean
            failed_outlier_check:
              type: boolean
        weight:
          type: integer
          description: Load balancing weight
        locality:
          type: object
          properties:
            region:
              type: string
            zone:
              type: string
            sub_zone:
              type: string
    ClustersResponse_2:
      type: object
      description: Information about upstream clusters
      properties:
        cluster_statuses:
          type: array
          items:
            $ref: '#/components/schemas/ClusterStatus_2'
  parameters:
    FormatParam:
      name: format
      in: query
      description: Output format for the response data.
      required: false
      schema:
        type: string
        enum:
        - json
        - text
        default: text
externalDocs:
  description: Envoy Admin Interface Documentation
  url: https://www.envoyproxy.io/docs/envoy/latest/operations/admin
x-refined-from:
- envoy-admin-api-openapi.yml
- envoy-admin-api-openapi_2.yml