List secrets of a single secret-manager type
GET /apisix/admin/secrets/{secret_type}
GET /apisix/admin/secrets/{secret_type}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
secret_type*string
Secret manager backend.
Value in
- "vault"
- "aws"
- "gcp"
Response Body
application/json
application/json
curl -X GET "http://127.0.0.1:9180/apisix/admin/secrets/vault"Paginated list of secrets for this manager.
{
"total": 0,
"list": [
{}
]
}**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"
}Complete operation details and schema variants
GET /apisix/admin/secrets/{secret_type}
List secrets of a single secret-manager type
Returns secrets registered under the given manager (vault, aws, or gcp). For listing across all managers, use GET /apisix/admin/secrets.
Parameters
secret_type(path, string, required): Secret manager backend.
Responses
200: Paginated list of secrets for this manager.total(integer, optional):list(array, 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.
cURL
curl -X GET 'http://127.0.0.1:9180/apisix/admin/secrets/{secret_type}'