Adding documentation on new http response code setting

jazzband · Aug 19, 2021 · e36665e · e36665e
1 parent 2368a7a
commit e36665e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/4_configuration.rst b/docs/4_configuration.rst
@@ -114,6 +114,10 @@ The following ``settings.py`` options are available for customizing Axes behavio
   Default: ``False``
 * ``AXES_ALLOWED_CORS_ORIGINS``: Configures lockout response CORS headers for XHR requests.
   Default: ``*``
+* ``AXES_HTTP_RESPONSE_CODE``: Sets the http response code returned when ``AXES_FAILURE_LIMIT`` is
+  reached.
+  For example: ``AXES_HTTP_RESPONSE_CODE = 429``
+  Default: ``403``
 
 The configuration option precedences for the access attempt monitoring are: