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...
GET Get JSON Schema /v1/schemaGet the JSON schema used by the gateway instance. Only loaded plugins are included.
GET Get Health Check Information /v1/healthcheckGet health check information for this APISIX instance. Send traffic to initialize upstream checker targets. The listing also includes checkers exposed by enabled plugins, such as ai-proxy-multi. An empty listing, and a checker with no targets, use JSON arrays ([]). Each plugin...
GET List All Checkers Owned by a Resource /v1/healthcheck/{src_type}/{src_id}/checkersList the upstream checker and checkers exposed by enabled plugins on this resource. Returns an empty array for an existing resource without checkers. Does not follow a route's service or upstream references; query the owning resource. The Control API has no authentication and...
GET Get Health Status By Type and ID /v1/healthcheck/{src_type}/{src_id}Get the single upstream health checker for a resource. This endpoint retains an object response and returns 404 when the resource has no upstream checker, even if a plugin owns checkers. Use the /checkers subresource to list both upstream and plugin-owned checkers.
POST Trigger 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.
GET Get All Routes /v1/routesGet all configured routes.
GET Get Route by ID /v1/route/{route_id}Get a route by ID.
GET Get All Upstreams /v1/upstreamsGet all configured upstreams.
GET Get Upstream by ID /v1/upstream/{upstream_id}Get an upstream by ID.
GET Get All Services /v1/servicesGet all configured services.
GET Get Service by ID /v1/service/{service_id}Get a service by ID.
GET Get All Plugin Metadata /v1/plugin_metadatasGet all plugin metadata.
GET Get Plugin Metadata by Name /v1/plugin_metadata/{plugin_name}Get plugin metadata by the plugin name.
PUT Reload All Plugins /v1/plugins/reloadHot reload plugins for changes to the plugin list in configuration files or plugin source files to take effect.
GET Get 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.
GET Get 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.
GET Get 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.