Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Envoy Clusters API

Upstream cluster inspection and status endpoints

Envoy Clusters API is one of 15 APIs that Envoy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a GitHub repository, and a changelog.

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.31.0.

Requests are made against a single base URL, http://localhost:9901.

1 operations 1 paths 6 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.31.0
Server
http://localhost:9901
Terms of Service
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Clusters 1

Upstream cluster inspection and status endpoints

GET
/clusters
Envoy Get upstream cluster information
getClusters 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are HostStatus_2 (5 properties), HostStatus (5 properties), ClusterStatus_2 (4 properties), ClusterStatus (4 properties). Each schema is shown below with its type and property counts.

HostStatus
object
Status of an individual upstream host within a cluster
5 properties
ClustersResponse
object
Information about all configured upstream clusters
1 property
ClusterStatus
object
Status of an individual upstream cluster
4 properties
HostStatus_2
object
Status of an individual host within a cluster
5 properties
ClustersResponse_2
object
Information about upstream clusters
1 property
ClusterStatus_2
object
Status of an individual upstream cluster
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

envoy-clusters-api-openapi.yml Raw ↑

Other APIs Envoy publishes across the network.

Envoy xDS APIs
Envoy API V3
Envoy Gateway API
Envoy Certificates API
Envoy Chat API
Envoy Configuration API
Envoy Health API
Envoy Listeners API
Envoy Logging API
Envoy Models API
Envoy Runtime API
Envoy Server API