upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-02-20 00:13:53 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Improve docs around enable_rate_limit_response_headers (#22302)

Browse source
This commit is contained in:
Violet Hynes 2023-08-11 13:43:28 -04:00 committed by GitHub
parent b97ce912cb
commit c6bd2db5b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
website/content/api-docs/system/quotas-config.mdx
View file

@ -21,7 +21,17 @@ The `/sys/quotas/config` endpoint is used to configure rate limit quotas.
- `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.
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 the `X-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 the `Retry-After` header.
### Sample payload