Skip to content

Commit

Permalink
Improve docs around enable_rate_limit_response_headers (#22302)
Browse files Browse the repository at this point in the history
  • Loading branch information
VioletHynes authored Aug 11, 2023
1 parent b97ce91 commit c6bd2db
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion website/content/api-docs/system/quotas-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit c6bd2db

Please sign in to comment.