List All Secrets
GET /apisix/admin/secrets
GET /apisix/admin/secretsInteractive 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
Query Parameters
page?integer
Page number (1-based).
Range
1 <= valueDefault
1page_size?integer
Items per page (10–500). When omitted, no pagination is applied and the full list is returned.
Range
10 <= value <= 500Response Body
application/json
application/json
curl -X GET "http://127.0.0.1:9180/apisix/admin/secrets?page=1&page_size=20"Successful response.
{
"total": 1,
"list": [
{
"createdIndex": 179,
"key": "/apisix/secrets/vault/1",
"value": {
"token": "343effad",
"id": "vault/1",
"uri": "https://localhost/vault",
"prefix": "/apisix/kv",
"update_time": 1684395392,
"create_time": 1684395392
},
"modifiedIndex": 179
}
]
}**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
List All Secrets
Retrieve all configured secret manager integrations.
Parameters
page(query, integer, optional): Page number (1-based).page_size(query, integer, optional): Items per page (10–500). When omitted, no pagination is applied and the full list is returned.
Responses
200: Successful response.list(array, optional): An array of secret configuration objects.list[].value(object, optional): Secret values.list[].value.id(string, optional): Unique identifier for the secret configuration, including the secret manager type and ID.list[].value.prefix(string, optional): Path prefix of the secret engine that Vault should route to.list[].value.token(string, optional): Token used for APISIX to authenticate to Vault.list[].value.create_time(integer, optional): Creation time of the secret.list[].value.update_time(integer, optional): Update time of the secret.list[].value.uri(string, optional): Address of the Vault server.list[].key(string, optional): Unique key identifier for this secret in the data store.list[].modifiedIndex(integer, optional): The index number representing the most recent update to the object. It starts with the same value ascreatedIndexand increases by 1 each time the resource is modified.list[].createdIndex(integer, optional): The index number representing when the object was first created. It indicates the creation order of the resource.total(integer, optional): Total number of secrets matching the query criteria.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'