Skip to content

Commit 3a6d6d2

Browse files
authored
API v3: document rate limit and pagination (#12063)
Had a user asking for this. <!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--12063.org.readthedocs.build/12063/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--12063.org.readthedocs.build/12063/ <!-- readthedocs-preview dev end -->
1 parent 3442f7f commit 3a6d6d2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/user/api/v3.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,19 @@ Session
4747

4848
Session authentication is allowed, so the API can be used by our dashboard and other internal services.
4949

50+
Rate limiting
51+
~~~~~~~~~~~~~
52+
53+
The API limits unauthenticated requests to 5 per minute and authenticated requests to 60 per minute.
54+
55+
Pagination
56+
~~~~~~~~~~
57+
58+
All endpoints that return a list of objects are paginated.
59+
By default, 10 objects are returned per page,
60+
but you can change this using the ``limit`` query parameter.
61+
The response includes a ``count``, ``next``, and ``previous`` attributes to navigate between pages.
62+
5063
Resources
5164
---------
5265

0 commit comments

Comments
 (0)