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

Health check management endpoints

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

Tagged areas include Health. 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 3 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 1.31.0.

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

3 operations 3 paths 0 schemas 1 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 3

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

Health 3

Health check management endpoints

POST
/health_check/fail
Envoy Force health check failure
setHealthCheckFail → 200
POST
/health_check/ok
Envoy Restore health check passing
setHealthCheckOk → 200
GET
/ready
Envoy Get server readiness status
getReady → 200503

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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