webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-28 17:02:04 +03:00
Code Activity

Added rate limit section to the API docs

Browse Source 
Closes #3423
This commit is contained in:
Dan Brown
2022-05-09 15:12:29 +01:00
parent b4f29a85ab
commit 96436839f1
2 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
resources/views/api-docs/parts/getting-started.blade.php
View File

@ -160,4 +160,23 @@
"message": "No authorization token found on the request"
}
}
</code></pre>
</code></pre>
<hr>
<h5 id="rate-limits" class="text-mono mb-m">Rate Limits</h5>
<p>
The API has built-in per-user rate-limiting to prevent potential abuse using the API.
By default, this is set to 180 requests per minute but this can be changed by an administrator
by setting an "API_REQUESTS_PER_MIN" .env option like so:
</p>
<pre><code class="language-bash"># The number of API requests that can be made per minute by a single user.
API_REQUESTS_PER_MIN=180</code></pre>
<p>
When the limit is reached you will receive a 429 "Too Many Attempts." error response.
It's generally good practice to limit requests made from your API client, where possible, to avoid
affecting normal use of the system caused by over-consuming system resources.
Keep in mind there may be other rate-limiting factors such as web-server & firewall controls.
</p>