encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-02 19:40:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update Throttling documentation for client identification method

Browse Source
This commit is contained in:
kahnjw 2013-12-06 14:07:08 -08:00
parent 0dcdf43828
commit 270f684572
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api-guide/throttling.md
View File

@ -41,9 +41,11 @@ The default throttling policy may be set globally, using the `DEFAULT_THROTTLE_C
The rate descriptions used in `DEFAULT_THROTTLE_RATES` may include `second`, `minute`, `hour` or `day` as the throttle period.
Additionally the number of application proxies can be set using `NUM_PROXIES`. This
setting will allow the throttle to correctly identify unique requests when there are
multiple application side proxies in front of the server.
By default Django REST Framework will try to use the `HTTP_X_FORWARDED_FOR`
header to uniquely identify client machines for throttling. If
HTTP_X_FORWARDED_FOR is not present `REMOTE_ADDR` header value will be used.
To help Django REST Framework identify unique clients the number of application proxies can be set using `NUM_PROXIES`. This setting will allow the throttle to correctly identify unique requests whenthere are multiple application side proxies in front of the server. `NUM_PROXIES` should be set to an integer. It is important to understand that if you configure `NUM_PROXIES > 0` all clients behind a unique [NAT'd](http://en.wikipedia.org/wiki/Network_address_translation) gateway will be treated as a single client.
You can also set the throttling policy on a per-view or per-viewset basis,
using the `APIView` class based views.