From c6bd2db5b09fe1bc587683ffb42d5202c5bcaf6d Mon Sep 17 00:00:00 2001 From: Violet Hynes Date: Fri, 11 Aug 2023 13:43:28 -0400 Subject: [PATCH] Improve docs around enable_rate_limit_response_headers (#22302) --- website/content/api-docs/system/quotas-config.mdx | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/website/content/api-docs/system/quotas-config.mdx b/website/content/api-docs/system/quotas-config.mdx index 1ec09b1fda..1039c87a07 100644 --- a/website/content/api-docs/system/quotas-config.mdx +++ b/website/content/api-docs/system/quotas-config.mdx @@ -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