Envoy

Envoy Listeners API

Listener inspection and drain endpoints

GitHub OpenAPI

Operations 2

GET /listeners Envoy Get listener information #
POST /drain_listeners Envoy Drain listeners #

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-listeners-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-listeners-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-listeners-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Envoy Listeners API
  version: 1.31.0
  description: 'Operations tagged Listeners 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: Listeners
  description: Listener inspection and drain endpoints
paths:
  /listeners:
    get:
      operationId: getListeners
      summary: Envoy Get listener information
      description: Returns information about all configured listeners including their names, bound addresses and ports, and associated statistics. Supports JSON or text output format.
      tags:
      - Listeners
      parameters:
      - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Listener information retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListenersResponse'
            text/plain:
              schema:
                type: string
    servers:
    - url: http://localhost:9901
      description: Default Envoy Admin Interface
  /drain_listeners:
    post:
      operationId: drainListeners
      summary: Envoy Drain listeners
      description: Initiates graceful draining of all listeners, stopping new connections from being accepted while allowing existing connections to complete. Useful before shutting down an Envoy instance or removing it from a load balancer.
      tags:
      - Listeners
      parameters:
      - name: inboundonly
        in: query
        description: When true, only drain inbound listeners.
        required: false
        schema:
          type: boolean
          default: false
      - name: graceful
        in: query
        description: When true, perform a graceful drain that allows time for connections to complete.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Listener drain initiated
          content:
            text/plain:
              schema:
                type: string
    servers:
    - url: http://localhost:9901
      description: Default Envoy Admin Interface
components:
  schemas:
    ListenersResponse:
      type: object
      description: Information about all configured listeners
      properties:
        listener_statuses:
          type: array
          description: List of listener status objects
          items:
            type: object
            properties:
              name:
                type: string
                description: Listener name
              local_address:
                type: object
                description: Address this listener is bound to
                properties:
                  socket_address:
                    type: object
                    properties:
                      address:
                        type: string
                        description: IP address or hostname
                      port_value:
                        type: integer
                        description: Port number
              additional_local_addresses:
                type: array
                description: Additional addresses this listener is bound to
                items:
                  type: object
    ListenersResponse_2:
      type: object
      description: Information about configured listeners
      properties:
        listener_statuses:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Listener name
              local_address:
                type: object
                properties:
                  socket_address:
                    type: object
                    properties:
                      address:
                        type: string
                      port_value:
                        type: integer
  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