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 Listeners API

Listener inspection and drain endpoints

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

Tagged areas include Listeners. 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 2 operations across 2 paths, and defines 2 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.

2 operations 2 paths 2 schemas 1 GET1 POST

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 2

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

Listeners 2

Listener inspection and drain endpoints

GET
/listeners
Envoy Get listener information
getListeners 1 param → 200
POST
/drain_listeners
Envoy Drain listeners
drainListeners 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ListenersResponse_2 (1 property), ListenersResponse (1 property). Each schema is shown below with its type and property counts.

ListenersResponse
object
Information about all configured listeners
1 property
ListenersResponse_2
object
Information about configured listeners
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

envoy-listeners-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 Clusters API
Envoy Configuration API
Envoy Health API
Envoy Logging API
Envoy Models API
Envoy Runtime API
Envoy Server API