apisix
16 commands
16 shown
List routes via Admin API
List all APISIX routes with URI and upstream
curl -s http://apisix:9180/apisix/admin/routes -H 'X-API-KEY: <key>' | jq '.list[].value | {id:.id, uri:.uri, upstream:.upstream.nodes}'
Get specific route
Inspect a single APISIX route configuration
curl -s http://apisix:9180/apisix/admin/routes/<id> -H 'X-API-KEY: <key>' | jq .
List upstreams
All APISIX upstream definitions with nodes
curl -s http://apisix:9180/apisix/admin/upstreams -H 'X-API-KEY: <key>' | jq '.list[].value | {id:.id, nodes:.nodes}'
List plugins
All available APISIX plugins
curl -s http://apisix:9180/apisix/admin/plugins/list -H 'X-API-KEY: <key>' | jq .
Reload APISIX config
Hot-reload APISIX configuration from etcd
curl -X PUT http://apisix:9180/apisix/admin/configs/reload -H 'X-API-KEY: <key>'
Check APISIX health
APISIX process health via control plane API
curl -s http://apisix:9080/apisix/status | jq .
Check APISIX status
Check APISIX pods are running in Kubernetes
kubectl get pods -n ingress-apisix
List routes via Admin API
List all configured APISIX routes
curl http://apisix-admin:9180/apisix/admin/routes -H "X-API-KEY: $ADMIN_KEY"
Create route
Create a simple route with roundrobin upstream
curl -X PUT http://apisix-admin:9180/apisix/admin/routes/1 -H "X-API-KEY: $ADMIN_KEY" -d '{"uri":"/api/*","upstream":{"nodes":{"backend:8080":1},"type":"roundrobin"}}'
Enable plugin on route
Add rate-limiting plugin to an existing route
curl -X PATCH http://apisix-admin:9180/apisix/admin/routes/1 -H "X-API-KEY: $ADMIN_KEY" -d '{"plugins":{"limit-req":{"rate":100,"burst":50,"key":"remote_addr"}}}'
List upstreams
List all configured APISIX upstreams
curl http://apisix-admin:9180/apisix/admin/upstreams -H "X-API-KEY: $ADMIN_KEY"
Create consumer
Create an APISIX consumer with key authentication
curl -X PUT http://apisix-admin:9180/apisix/admin/consumers/myuser -H "X-API-KEY: $ADMIN_KEY" -d '{"plugins":{"key-auth":{"key":"user-api-key"}}}'
Enable JWT auth plugin
Enable JWT authentication on a route via plugin config
# Add jwt-auth to plugins in route or consumer config
List plugins
List all available APISIX plugins
curl http://apisix-admin:9180/apisix/admin/plugins/list -H "X-API-KEY: $ADMIN_KEY"
Reload APISIX config
Hot-reload APISIX configuration without downtime
apisix reload
Enable JWT auth plugin
Add jwt-auth plugin to an existing route via Admin API
curl -X PATCH http://apisix-admin:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $ADMIN_KEY" \
-d '{"plugins":{"jwt-auth":{"header":"Authorization","query":"jwt"}}}'
no commands match