API7 Docs
API7 GatewayAPI7 Enterprise Admin APIsList all plugin names

List all plugin names

GET /apisix/admin/plugins/list

GET /apisix/admin/plugins/list

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Query Parameters

has_metadata?boolean

If true, show plugin names where the plugins have metadata.

Defaultfalse
subsystem?string

Type to filter the plugin list. http will only show L7 plugins and stream will only show L4 plugins.

Default"http"

Value in

  • "http"
  • "stream"

Response Body

application/json

curl -X GET "$API_BASE_URL/apisix/admin/plugins/list"

Successfully retrieved the list of available plugin names.

[
  "ip-restriction",
  "limit-conn",
  "mqtt-proxy",
  "prometheus",
  "syslog"
]
Complete operation details and schema variants

GET /apisix/admin/plugins/list

List all plugin names

Parameters

  • has_metadata (query, boolean, optional): If true, show plugin names where the plugins have metadata.
  • subsystem (query, string, optional): Type to filter the plugin list. http will only show L7 plugins and stream will only show L4 plugins.

Responses

  • 200: Successfully retrieved the list of available plugin names.

cURL

curl -X GET '$API_BASE_URL/apisix/admin/plugins/list'