Skip to main content
Version: Next



The node-status Plugin can be used get the status of requests to APISIX by exposing an API endpoint.




This Plugin will add the endpoint /apisix/status to expose the status of APISIX.

You may need to use the public-api Plugin to expose the endpoint.

Enable Plugin#

To configure the node-status Plugin, you have to first enable it in your configuration file (conf/config.yaml):

- example-plugin
- limit-req
- jwt-auth
- zipkin
- node-status

You have to the setup the Route for the status API and expose it using the public-api Plugin.


You can fetch the admin_key from config.yaml and save to an environment variable with the following command:

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
curl -H "X-API-KEY: $admin_key" -X PUT -d '
"uri": "/apisix/status",
"plugins": {
"public-api": {}

Example usage#

Once you have configured the Plugin, you can make a request to the apisix/status endpoint to get the status:

curl -i
HTTP/1.1 200 OK
Date: Tue, 03 Nov 2020 11:12:55 GMT
Content-Type: text/plain; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Server: APISIX web server


The parameters in the response are described below:

statusStatus of APISIX.
totalTotal number of client requests.
waitingNumber of idle client connections waiting for a request.
acceptedNumber of accepted client connections.
writingNumber of connections to which APISIX is writing back a response.
handledNumber of handled connections. Generally, this value is the same as accepted unless any a resource limit is reached.
activeNumber of active client connections including waiting connections.
readingNumber of connections where APISIX is reading the request header.
idUID of APISIX instance saved in apisix/conf/apisix.uid.

Delete Plugin#

To remove the Plugin, you can remove it from your configuration file (conf/config.yaml):

- example-plugin
- limit-req
- jwt-auth
- zipkin

You can also remove the Route on /apisix/status:

curl -H "X-API-KEY: $admin_key" -X DELETE