4d66fb9603
* update rate limit documentation * regenerate landingpage config helpers * make rate limit rate configurable
1.8 KiB
Rate Limit
To mitigate abuse + scraping of your instance, an IP-based HTTP rate limit is in place.
This rate limit applies not just to the API, but to all requests (web, federation, etc).
By default, a maximum of 1000 requests in a 5 minute time window are allowed.
Every response will include the current status of the rate limit with the following headers:
X-Ratelimit-Limit: maximum number of requests allowed per time period.X-Ratelimit-Remaining: number of remaining requests that can still be performed within.X-Ratelimit-Reset: unix timestamp indicating when the rate limit will reset.
In case the rate limit is exceeded, an HTTP 429 Too Many Requests error is returned to the caller.
Rate Limiting FAQs
My rate limit keeps being exceeded! Why?
If you find that your rate limit is regularly being exceeded (both for yourself and other callers) during normal use of your instance, it's possible that your trusted-proxies setting is not configured correctly. This can result in your instance seeing all incoming IP addresses as the same address: namely, the IP address of your reverse proxy. This means that all incoming requests are sharing the same rate limit, rather than being split correctly per IP.
You can investigate this by viewing the logs of your instance. If (almost) all logged IP addresses appear to be the same IP address (something like 172.x.x.x), then it's likely that your trusted-proxies is not correctly configured. If this is the case, try adding the IP address of your reverse proxy to the list of trusted-proxies, and restarting your instance.
Can I configure the rate limit? Can I just turn it off?
Yes! See the config setting advanced-rate-limit-requests.