{"result":{"depiction_url":null,"edges":{"observes":{"objects":[{"created":"2026-09-09T13:47:42Z","object_id":{"id":1731,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_auth_reset","title":"observe_auth_reset\/2","uri":"https:\/\/zotonic.com\/id\/1731"},"seq":1},{"created":"2026-09-09T13:47:42Z","object_id":{"id":1838,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_auth_precheck","title":"observe_auth_precheck\/2","uri":"https:\/\/zotonic.com\/id\/1838"},"seq":2},{"created":"2026-09-09T13:47:42Z","object_id":{"id":2077,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_auth_checked","title":"observe_auth_checked\/2","uri":"https:\/\/zotonic.com\/id\/2077"},"seq":3},{"created":"2026-09-09T13:47:42Z","object_id":{"id":2136,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_auth_logon","title":"observe_auth_logon\/3","uri":"https:\/\/zotonic.com\/id\/2136"},"seq":4}],"predicate":{"id":2550,"is_a":["meta","predicate"],"name":"observes","title":{"_type":"trans","tr":{"en":"Observes"}},"uri":"https:\/\/zotonic.com\/id\/observes"}},"subject":{"objects":[{"created":"2026-09-09T13:47:42Z","object_id":{"id":2555,"is_a":["categorization","keyword","keyword_information_type"],"name":"zotonic_topic_reference","title":"Reference","uri":"https:\/\/zotonic.com\/id\/2555"},"seq":1},{"created":"2026-09-09T13:47:42Z","object_id":{"id":2566,"is_a":["categorization","keyword","keyword_audience"],"name":"zotonic_topic_operator","title":"Operator","uri":"https:\/\/zotonic.com\/id\/2566"},"seq":2},{"created":"2026-09-09T13:47:42Z","object_id":{"id":2635,"is_a":["categorization","keyword","keyword_architecture"],"name":"zotonic_topic_module","title":"Module","uri":"https:\/\/zotonic.com\/id\/2635"},"seq":3},{"created":"2026-09-09T13:47:42Z","object_id":{"id":2676,"is_a":["categorization","keyword","keyword_technology"],"name":"zotonic_topic_http","title":"HTTP","uri":"https:\/\/zotonic.com\/id\/2676"},"seq":4},{"created":"2026-09-09T13:47:42Z","object_id":{"id":2685,"is_a":["categorization","keyword","keyword_quality"],"name":"zotonic_topic_security","title":"Security","uri":"https:\/\/zotonic.com\/id\/2685"},"seq":5},{"created":"2026-09-09T13:47:42Z","object_id":{"id":2688,"is_a":["categorization","keyword","keyword_quality"],"name":"zotonic_topic_performance","title":"Performance","uri":"https:\/\/zotonic.com\/id\/2688"},"seq":6}],"predicate":{"id":308,"is_a":["meta","predicate"],"name":"subject","title":{"_type":"trans","tr":{"en":"Keyword"}},"uri":"http:\/\/purl.org\/dc\/elements\/1.1\/subject"}}},"id":1732,"is_a":["text","documentation","reference","module"],"links":[{"rel":"self","target":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/1732"},{"rel":"hub","target":"https:\/\/zotonic.com\/.zotonic\/websub"}],"medium":null,"medium_url":null,"name":"doc_module_mod_ratelimit","page_url":{"en":"https:\/\/zotonic.com\/docs\/1732\/mod_ratelimit","x-default":"https:\/\/zotonic.com\/docs\/1732\/mod_ratelimit"},"preview_url":null,"resource":{"version":3345,"pivot_location_lat":null,"title":"mod_ratelimit","is_authoritative":true,"body":"<p>Implements rate limiting for various resources.<\/p>\n<p>After activation rate limiting will be added to the login and password reset flow.<\/p>\n<p>The rate limiting is done on username or e-mail address. After five attempts the username (or e-mail address) will be\nblocked for an hour.<\/p>\n<p>If a username is used for a successful login, then a special <em>device-id<\/em> cookie is placed on the user-agent. This\ndevice-id ensures that that particular user-agent is allowed its own five tries. This prevents a username to be blocked\non known devices by tries on other devices. The device-id cookie is only valid for a single username.<\/p>\n<h2>Accepted Events<\/h2>\n<p>This module handles the following notifier callbacks:<\/p>\n<ul><li><code>observe_auth_checked<\/code>: Register failed authentication attempts for rate limiting and clear counters on successful logins.<\/li><li><code>observe_auth_logon<\/code>: Authentication succeeded, set the device id cookie (if we have a username from auth_checked) using <code>z_ids:id<\/code>.<\/li><li><code>observe_auth_precheck<\/code>: Check if rate limiting applies to this authentication request using <code>m_ratelimit:is_event_limited<\/code>.<\/li><li><code>observe_auth_reset<\/code>: Auth reset requested, register it against the device cookie using <code>m_ratelimit:is_event_limited<\/code>.<\/li><li><code>observe_tick_6h<\/code>: Prune logged auth events using <code>m_ratelimit:prune<\/code>.<\/li><\/ul>\n<p>Delegate callbacks:<\/p>\n<ul><li><code>event\/2<\/code> with <code>postback<\/code> messages: <code>reset_ratelimit<\/code>.<\/li><\/ul>","slug":"mod_ratelimit","doc_module_config":[{"default":"[]","description":"The secret used to sign the device cookie. The device cookie is used to give known browsers their own rate limiting. This is automatically generated and must be kept secret.","has_default":true,"key":"device_secret","module":"mod_ratelimit","type":"string"},{"default":"3600","description":"The period in seconds for counting events, defaults to 3600 seconds (1 hour).","has_default":true,"key":"event_period","module":"mod_ratelimit","type":"integer"},{"default":"5","description":"The number of events before a rate limit is applied, defaults to 5.","has_default":true,"key":"event_count","module":"mod_ratelimit","type":"integer"}],"is_protected":false,"visible_for":0,"tz":"UTC","language":["en"],"doc_source_hash":"cca65eb45a43c35eb50b35b8663ba736943aebec12bfdc3b85e49d28e91f6b4f","is_featured":false,"content_group_id":{"id":2551,"is_a":["meta","content_group"],"name":"content_group_imported_docs","title":"Imported documentation","uri":"https:\/\/zotonic.com\/id\/content_group_imported_docs"},"category_id":{"id":320,"is_a":["meta","category"],"name":"module","title":"Modules","uri":"https:\/\/test.zotonic.com\/id\/320"},"doc_source_path":"apps\/zotonic_mod_ratelimit\/src\/mod_ratelimit.erl","publication_start":"2023-01-30T19:24:02Z","github_url":"https:\/\/github.com\/zotonic\/zotonic\/blob\/master\/apps\/zotonic_mod_ratelimit\/src\/mod_ratelimit.erl","pivot_location_lng":null,"doc_source_kind":"module","name":"doc_module_mod_ratelimit","is_unfindable":false,"is_published":true,"pivot_geocode":null,"created":"2020-05-30T05:47:32Z","uri":null,"doc_status":"current","is_dependent":false,"erlang_app":"zotonic_mod_ratelimit","publication_end":"9999-06-01T00:00:00Z","modifier_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"privacy":0,"doc_source_commit":"652b4eddf9263041a2798f290b6c867343988a3f\n","creator_id":{"id":336,"is_a":["person","robot"],"name":"gitbot","title":"Git","uri":"https:\/\/zotonic.com\/id\/336"},"modified":"2026-10-06T13:25:05Z","title_slug":"mod_ratelimit"},"uri":"https:\/\/zotonic.com\/id\/1732","uri_template":"https:\/\/zotonic.com\/id\/:id","websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/1732"}},"status":"ok"}