Get a plugin metadata on a gateway group

GET /apisix/admin/plugin_metadata/{plugin_name}

Interactive request editor loads with JavaScript.

Path Parameters

plugin_name*string

Name of the plugin.

Length1 <= length <= 64

Query Parameters

gateway_group_id*string

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

Length1 <= length

return_default?boolean

When set to true, the default value is returned when plugin metadata is not found.

Defaultfalse

Response Body

`application/json`

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

Successfully retrieved or modified the plugin metadata.

{
  "value": {
    "disabled_labels": {
      "status": [
        "code"
      ]
    }
  }
}

Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

{
  "value": {},
  "error_msg": "error message"
}

Complete operation details and schema variants

GET /apisix/admin/plugin_metadata/{plugin_name}

Get a plugin metadata on a gateway group

Retrieve metadata for a specific plugin type in the gateway group. You can optionally request default metadata values for comparison. 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.
plugin_name (path, string, required): Name of the plugin.
return_default (query, boolean, optional):

Responses

200: Successfully retrieved or modified the plugin metadata.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional): Plugin metadata.
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/{plugin_name}'

Get a plugin metadata on a gateway group

200application/json

400application/json

`application/json`

`application/json`