How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Apache APISIX

Apache APISIX Health Check API

Monitor the health status of upstream nodes.

Documentation Provider Profile APIs.io OpenAPI GitHub

Apache APISIX Health Check API is one of 18 APIs that Apache APISIX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Health Check. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 3.14.0.

Requests are made against a single base URL, http://127.0.0.1:9180/apisix/admin.

4 operations 4 paths 1 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Server
http://127.0.0.1:9180/apisix/admin
Authentication
API Key
Contact
Apache APISIX
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

Apache APISIX Health Check API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (apiKey). By default, every request must be authenticated.

  • apiKey — Admin API key for authentication.

Paths & Operations 4

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

Health Check 4

Monitor the health status of upstream nodes.

GET
/v1/healthcheck
Apache APISIX Get All Health Check Statuses
getHealthCheck → 200
GET
/v1/healthcheck/upstreams/{upstream_id}
Apache APISIX Get Health Check for a Specific Upstream
getUpstreamHealthCheck 1 param → 200404
GET
/v1/healthcheck/routes/{route_id}
Apache APISIX Get Health Check for a Specific Route
getRouteHealthCheck 1 param → 200404
GET
/v1/healthcheck/services/{service_id}
Apache APISIX Get Health Check for a Specific Service
getServiceHealthCheck 1 param → 200404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is HealthCheckStatus (3 properties). Each schema is shown below with its type and property counts.

HealthCheckStatus
object
Health check status for an upstream or route.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apache-apisix-health-check-api-openapi.yml Raw ↑

Other APIs Apache APISIX publishes across the network.

Apache APISIX Gateway
AE Profile APIs.io
Apache APISIX Consumer Groups API
AE Profile APIs.io
Apache APISIX Consumers API
AE Profile APIs.io
Apache APISIX Diagnostics API
AE Profile APIs.io
Apache APISIX Global Rules API
AE Profile APIs.io
Apache APISIX Introspection API
AE Profile APIs.io
Apache APISIX Plugin Configs API
AE Profile APIs.io
Apache APISIX Plugin Metadata API
AE Profile APIs.io
Apache APISIX Plugins API
AE Profile APIs.io
Apache APISIX Protos API
AE Profile APIs.io
Apache APISIX Routes API
AE Profile APIs.io
Apache APISIX Schema API
AE Profile APIs.io
#Health Check
← Back to A APIs
API Details
ID
apache-apisix:apache-apisix-health-check-api
Server
http://127.0.0.1:9180/apisix/admin
Docs
https://apisix.apache.org/
Provider
Apache APISIX
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=apache-apisix-health-check-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/apache-apisix-health-check-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Apache APISIX Health Check API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.