Envoy

Envoy Health API

Health check management endpoints

GitHub OpenAPI

Operations 3

POST /health_check/fail Envoy Force health check failure #
POST /health_check/ok Envoy Restore health check passing #
GET /ready Envoy Get server readiness status #

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-health-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-health-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-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Envoy Health API
  version: 1.31.0
  description: 'Operations tagged Health 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: Health
  description: Health check management endpoints
paths:
  /health_check/fail:
    post:
      operationId: setHealthCheckFail
      summary: Envoy Force health check failure
      description: Forces the Envoy server to fail all health checks from upstream load balancers. This is useful for draining traffic before a planned shutdown. The server continues to proxy existing connections.
      tags:
      - Health
      responses:
        '200':
          description: Health check set to failing state
          content:
            text/plain:
              schema:
                type: string
    servers:
    - url: http://localhost:9901
      description: Default Envoy Admin Interface
  /health_check/ok:
    post:
      operationId: setHealthCheckOk
      summary: Envoy Restore health check passing
      description: Restores the Envoy server to pass health checks from upstream load balancers after a prior call to /health_check/fail. The server will resume receiving new traffic.
      tags:
      - Health
      responses:
        '200':
          description: Health check restored to passing state
          content:
            text/plain:
              schema:
                type: string
    servers:
    - url: http://localhost:9901
      description: Default Envoy Admin Interface
  /ready:
    get:
      operationId: getReady
      summary: Envoy Get server readiness status
      description: Returns whether the Envoy server is ready to accept connections and proxy traffic. Returns HTTP 200 when ready and HTTP 503 when the server is not yet initialized or is shutting down.
      tags:
      - Health
      responses:
        '200':
          description: Server is ready to accept connections
          content:
            text/plain:
              schema:
                type: string
        '503':
          description: Server is not ready (initializing or draining)
          content:
            text/plain:
              schema:
                type: string
    servers:
    - url: http://localhost:9901
      description: Default Envoy Admin Interface
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