APISIX Control API
Use the APISIX Control API to inspect or control the runtime state of one APISIX instance. It is enabled by default at http://127.0.0.1:9090; configure apisix.enable control and apisix.control in...
Schema
GETGet JSON Schema/v1/schemaGet the JSON schema used by the gateway instance. Only loaded plugins are included.
Health Check
GETGet Health Check Information/v1/healthcheckGet health check information of the APISIX instance. You need to initiate a request to the route to generate Control API health check information.
GETGet Health Status By Type and ID/v1/healthcheck/{src_type}/{src_id}Get health status of a specified resource.
Garbage Collection
POSTTrigger Garbage Collection/v1/gcTrigger a full garbage collection (GC) in the HTTP subsystem. Note that a request to this endpoint would not trigger a garbage collection in the stream subsystem because the subsystems are run in the separate Lua VM.
Route
GETGet All Routes/v1/routesGet all configured routes.
GETGet Route by ID/v1/route/{route_id}Get a route by ID.
Upstream
GETGet All Upstreams/v1/upstreamsGet all configured upstreams.
GETGet Upstream by ID/v1/upstream/{upstream_id}Get an upstream by ID.
Service
GETGet All Services/v1/servicesGet all configured services.
GETGet Service by ID/v1/service/{service_id}Get a service by ID.
Plugin Metadata
GETGet All Plugin Metadata/v1/plugin_metadatasGet all plugin metadata.
GETGet Plugin Metadata by Name/v1/plugin_metadata/{plugin_name}Get plugin metadata by the plugin name.
Plugin
PUTReload All Plugins/v1/plugins/reloadHot reload plugins for changes to the plugin list in configuration files or plugin source files to take effect.
Service Discovery
GETGet Memory Dump/v1/discovery/{service}/dumpGet the in-memory service and configuration data for a configured service discovery module. This endpoint exists only when the module implements runtime data dumping.
GETGet Dump File/v1/discovery/{service}/show_dump_fileRead the persisted service discovery dump. This endpoint is currently provided by compatible service discovery modules such as Consul and exists only when the module is configured.
Server Information
GETGet Server Information/v1/server_infoGet information about the local APISIX instance. This endpoint is available only when the server-info plugin is enabled. The plugin is deprecated in APISIX 3.17.0.