API7 Docs
API7 GatewayAPI7 Enterprise Admin APIsList all plugin metadata on a gateway group

List all plugin metadata on a gateway group

GET /apisix/admin/plugin_metadata

GET /apisix/admin/plugin_metadata

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Query Parameters

gateway_group_id*string

Gateway group ID. Optional when using the gateway group admin key to authenticate.

Length1 <= length

Response Body

application/json

application/json

curl -X GET "$API_BASE_URL/apisix/admin/plugin_metadata?gateway_group_id=86fb9981-d9d2-4555-9df8-91ae92129335"

Successfully retrieved all plugin metadata entries for the gateway group.

{
  "value": {
    "prometheus": {
      "disabled_labels": {
        "status": [
          "code"
        ]
      }
    },
    "syslog": {
      "log_format": {
        "@timestamp": "$time_iso8601",
        "client_ip": "$remote_addr",
        "host": "$host",
        "route_id": "$route_id"
      }
    }
  }
}
Complete operation details and schema variants

GET /apisix/admin/plugin_metadata

List all plugin metadata on a gateway group

List plugin metadata objects configured in the gateway group. Plugin metadata provides shared settings for a plugin type across all its instances. Required IAM Permission: Action gateway:GetPluginMetadata, Resource arn:api7:gateway:gatewaygroup/%s

Parameters

  • gateway_group_id (query, string, required): Gateway group ID. Optional when using the gateway group admin key to authenticate.

Responses

  • 200: Successfully retrieved all plugin metadata entries for the gateway group.
  • allOf variant 1
  • value (object, optional): The specific resource.
  • allOf variant 2
  • value (object, optional): Plugin name to metadata map.
  • 400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
  • value (object, optional): The specific resource.
  • error_msg (string, optional): The error message.

cURL

curl -X GET '$API_BASE_URL/apisix/admin/plugin_metadata'

Global Rule

Previous Page

Get a plugin metadata on a gateway group

Next Page