api: Link to new rate-limiting configuration documentation.

This commit is contained in:
Alex Vandiver 2022-11-08 21:42:21 -05:00 committed by Tim Abbott
parent a9f2ec27d6
commit 0fa7b8e1ae
1 changed files with 5 additions and 2 deletions

View File

@ -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