Get a Plugin Config
GET /apisix/admin/plugin_configs/{id}
GET /apisix/admin/plugin_configs/{id}Interactive request editor loads with JavaScript.
X-API-KEY<token>
Admin API key configured in config.yaml under deployment.admin.admin_key. You can also pass the key as a query parameter api_key or cookie x_api_key.
In: header
Path Parameters
id*string
Unique identifier of the resource. Can be a string (alphanumeric, -, _, .) or a positive integer.
Response Body
application/json
application/json
application/json
curl -X GET "http://127.0.0.1:9180/apisix/admin/plugin_configs/my-resource-1"Successful response.
{
"value": {
"plugins": {
"limit-count": {
"rejected_code": 503,
"time_window": 60,
"key": "remote_addr",
"key_type": "var",
"count": 2,
"allow_degradation": false,
"show_limit_quota_header": true,
"policy": "local"
}
},
"desc": "desc",
"id": "1",
"create_time": 1684380007,
"update_time": 1684380034
},
"key": "/apisix/plugin_configs/1",
"modifiedIndex": 151,
"createdIndex": 150
}**Unauthorized** — The API key is missing, invalid, or lacks permission.
{
"error_msg": "failed to check token",
"description": "missing apikey"
}{
"error_msg": "failed to check token",
"description": "wrong apikey"
}{
"error_msg": "failed to check token",
"description": "invalid method for role viewer"
}Key not found
{
"error_msg": "Key not found"
}Complete operation details and schema variants
GET /apisix/admin/plugin_configs/{id}
Get a Plugin Config
Retrieve a single plugin config by its ID.
Parameters
id(path, string, required): Unique identifier of the resource. Can be a string (alphanumeric,-,_,.) or a positive integer.
Responses
200: Successful response.key(string, required):value(object, required): Plugin Config — a reusable set of plugin configurations that can be referenced by multiple routes.value.id(object, optional): Unique identifier for the resource. Can be a string (1–64 characters, alphanumeric with-,_,.) or a positive integer.- anyOf variant 1: String ID
- anyOf variant 2: Integer ID
value.name(string, optional): Human-readable name.value.desc(string, optional): Description.value.labels(object, optional): Key-value pairs for categorizing and filtering resources. Values must be non-empty strings (max 256 characters).value.create_time(integer, optional): Unix timestamp of creation. Read-only.value.update_time(integer, optional): Unix timestamp of last update. Read-only.value.plugins(object, required): Plugin configurations as a JSON object. Each key is a plugin name, and the value is that plugin's configuration object.
Example:
{
"limit-count": {
"count": 100,
"time_window": 60
},
"key-auth": {}
}
See the Plugin Hub for available plugins and their schemas.
createdIndex(integer, optional):modifiedIndex(integer, optional):401: Unauthorized — The API key is missing, invalid, or lacks permission.error_msg(string, required): Authentication error message.description(string, optional): Detailed reason for the authentication failure.404: Not Found — The specified resource does not exist.error_msg(string, required): Error message indicating the resource was not found.
cURL
curl -X GET 'http://127.0.0.1:9180/apisix/admin/plugin_configs/{id}'