Control API

    • expose APISIX internal state
    • control the behavior of a single isolate APISIX data panel

    By default, the control API server is enabled and listens to . You can change it via the control section under apisix in conf/config.yaml:

    Note that the control API server should not be configured to listen to the public traffic!

    Plugin can add its control API when it is enabled. If a plugin adds such a control API, please refer to each plugin’s documentation for those APIs.

    Plugin independent Control API

    Here is the supported API:

    Return the jsonschema used by this APISIX instance in the format below:

    For part, only enabled plugins will be returned. Some plugins may lack of fields like consumer_schema or type, it is depended on by the plugin’s definition.

    Introduced since v2.3.

    Return current status in the format below:

    • src_id: the id of object which creates the health checker. For example, if Upstream object with id 1 creates a health checker, the is upstreams and the src_id is 1.
    • name: the name of the health checker.
    • nodes: the target nodes of the health checker.

    User can also use /v1/healthcheck/$src_type/$src_id can get the status of a health checker.

    For example, returns:

    Introduced since v2.8.

    Trigger a full GC in the http subsystem. Note that when you enable stream proxy, APISIX will run another Lua VM for the stream subsystem. It won’t trigger a full GC in this Lua VM .