diff --git a/resources/views/api-docs/index.blade.php b/resources/views/api-docs/index.blade.php index 5bec265e8..52ad9f8f4 100644 --- a/resources/views/api-docs/index.blade.php +++ b/resources/views/api-docs/index.blade.php @@ -15,6 +15,7 @@
Request Format
Listing Endpoints
Error Handling
+
Rate Limits
@foreach($docs as $model => $endpoints) diff --git a/resources/views/api-docs/parts/getting-started.blade.php b/resources/views/api-docs/parts/getting-started.blade.php index 3bcf29dd4..edc526971 100644 --- a/resources/views/api-docs/parts/getting-started.blade.php +++ b/resources/views/api-docs/parts/getting-started.blade.php @@ -160,4 +160,23 @@ "message": "No authorization token found on the request" } } - \ No newline at end of file + + +
+ +
Rate Limits
+

+ 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: +

+ +
# The number of API requests that can be made per minute by a single user.
+API_REQUESTS_PER_MIN=180
+ +

+ 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. +

\ No newline at end of file