Probe standalone configuration availability
HEAD /apisix/admin/configs
HEAD /apisix/admin/configsInteractive 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
Response Body
application/json
curl -X HEAD "http://127.0.0.1:9180/apisix/admin/configs"Standalone configuration is reachable.
**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
HEAD /apisix/admin/configs
Probe standalone configuration availability
Returns 200 OK if the deployment is in YAML provider mode and the configuration endpoint is reachable.
Parameters
Responses
200: Standalone configuration is reachable.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 HEAD 'http://127.0.0.1:9180/apisix/admin/configs'