From 0fa7b8e1aeaadf18bb1563cc2906dba74e0d24dd Mon Sep 17 00:00:00 2001 From: Alex Vandiver Date: Tue, 8 Nov 2022 21:42:21 -0500 Subject: [PATCH] api: Link to new rate-limiting configuration documentation. --- templates/zerver/api/rest-error-handling.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/templates/zerver/api/rest-error-handling.md b/templates/zerver/api/rest-error-handling.md index 637534541e..1f818740fe 100644 --- a/templates/zerver/api/rest-error-handling.md +++ b/templates/zerver/api/rest-error-handling.md @@ -32,8 +32,9 @@ HTTP headers in all API responses: have any rate limits applied to it (and thus could do a burst of `X-RateLimit-Limit` requests). -Zulip's rate limiting rules are configurable, and can vary by server -and over time. The default configuration currently limits: +[Zulip's rate limiting rules are configurable][rate-limiting-rules], +and can vary by server and over time. The default configuration +currently limits: * Every user is limited to 200 total API requests per minute. * Separate, much lower limits for authentication/login attempts. @@ -41,3 +42,5 @@ and over time. The default configuration currently limits: When the Zulip server has configured multiple rate limits that apply to a given request, the values returned will be for the strictest limit. + +[rate-limiting-rules]: https://zulip.readthedocs.io/en/latest/production/security-model.html#rate-limiting