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

Server management, lifecycle, and information endpoints

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

Tagged areas include Server. 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 5 operations across 5 paths, and defines 3 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.

5 operations 5 paths 3 schemas 3 GET2 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 5

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

Server 5

Server management, lifecycle, and information endpoints

GET
/server_info
Envoy Get server information
getServerInfo → 200
POST
/quitquitquit
Shutdown Envoy server
shutdownServer → 200
GET
/memory
Envoy Get memory allocation information
getMemory → 200
GET
/hot_restart_version
Envoy Get hot restart compatibility version
getHotRestartVersion → 200
POST
/drain_listeners
Envoy Drain listeners
drainListeners 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ServerInfo_2 (7 properties), ServerInfo (7 properties), MemoryResponse (5 properties). Each schema is shown below with its type and property counts.

ServerInfo
object
Information about the running Envoy server instance
7 properties
MemoryResponse
object
Memory usage statistics for the Envoy process
5 properties
ServerInfo_2
object
Information about the running Envoy server instance
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

envoy-server-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 Listeners API
Envoy Logging API
Envoy Models API
Envoy Runtime API