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.
openapi: 3.2.0
info:
title: Apache APISIX Control Introspection API
description: The Apache APISIX Control API provides internal status and health check endpoints for monitoring and introspecting the running APISIX instance. By default, the Control API listens on port 9090 and is only accessible from localhost. It exposes endpoints for health checking, schema retrieval, and runtime diagnostics.
version: 3.14.0
contact:
name: Apache APISIX
url: https://apisix.apache.org
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://127.0.0.1:9090
description: Default local Control API server
tags:
- name: Introspection
description: Inspect the runtime configuration of the APISIX instance.
paths:
/v1/routes:
get:
operationId: getControlRoutes
summary: Apache APISIX Get All Configured Routes
description: Returns a list of all routes with their complete runtime configuration.
tags:
- Introspection
responses:
'200':
description: Successful response with list of routes.
content:
application/json:
schema:
type: array
items:
type: object
/v1/services:
get:
operationId: getControlServices
summary: Apache APISIX Get All Configured Services
description: Returns a list of all services with their complete runtime configuration.
tags:
- Introspection
responses:
'200':
description: Successful response with list of services.
content:
application/json:
schema:
type: array
items:
type: object
/v1/upstreams:
get:
operationId: getControlUpstreams
summary: Apache APISIX Get All Configured Upstreams
description: Returns a list of all upstreams with their complete runtime configuration.
tags:
- Introspection
responses:
'200':
description: Successful response with list of upstreams.
content:
application/json:
schema:
type: array
items:
type: object
/v1/discovery/{discovery_type}/dump:
get:
operationId: dumpDiscoveryNodes
summary: Apache APISIX Dump Service Discovery Nodes
description: Returns the nodes discovered by the specified service discovery type.
tags:
- Introspection
parameters:
- name: discovery_type
in: path
required: true
description: The type of service discovery (e.g. dns, consul, nacos).
schema:
type: string
responses:
'200':
description: Successful response with discovered nodes.
content:
application/json:
schema:
type: object
'404':
description: Discovery type not found.