/sys/quotas/config
Restricted endpoint
The API path can only be called from the root or administrative namespace.The /sys/quotas/config
endpoint is used to configure rate limit quotas.
Create or update the rate limit configuration
Method | Path |
---|---|
POST | /sys/quotas/config |
Parameters
rate_limit_exempt_paths
([]string: [])
- Specifies the list of exempt paths from all rate limit quotas. Exempt paths are relative and apply to all namespaces. Whenrate_limit_exempt_paths
is empty, Vault applies quotas to all relative paths. Access to exemption data is read-only from the admin namespace. You cannot updaterate_limit_exempt_paths
from the admin namespaceglobal_rate_limit_exempt_paths
([]string: [])
-Specifies the list of exempt paths from all rate limit quotas. Global exempt paths are absolute and do not apply across namespaces. Whenglobal_rate_limit_exempt_paths
is empty, Vault applies quotas to all absolute paths. You can only add, update, or delete global paths within the scope of the calling namespace.enable_rate_limit_audit_logging
(bool: false)
- If set, starts audit logging of requests that get rejected due to rate limit quota rule violations.enable_rate_limit_response_headers
(bool: false)
- If set, additional rate limit quota HTTP headers will be added to responses. These include:Retry-After
: If the request is blocked due to rate limiting, this will be a suggested time, in seconds, to wait before retry after. The time suggested will be the amount of time in seconds remaining before the rate limit quota applicable to this request is reset. Identical to theX-Ratelimit-Reset
header.X-Ratelimit-Limit
: The limit of the rate limit quota applicable to this request.X-Ratelimit-Remaining
: The remaining requests in the current interval for the rate limit quota applicable to this request.X-Ratelimit-Reset
The amount of time in seconds remaining before the rate limit quota applicable to this request is reset. Identical to theRetry-After
header.
Sample payload
Sample request
Get the rate limit configuration
Method | Path |
---|---|
GET | /sys/quotas/config |
Sample request
Sample response