Skip to content

Document response headers for rate limiting #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thetutlage merged 1 commit into from
Apr 1, 2026
Merged

Document response headers for rate limiting #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/guides/security/rate_limiting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,12 @@ When a user exhausts their rate limit, the middleware throws the `E_TOO_MANY_REQ

See also: [E_TOO_MANY_REQUESTS exception reference](../../reference/exceptions.md#e_too_many_requests)

The middleware will also add the following response headers:
- `X-RateLimit-Limit`: Total number of requests that can be made
- `X-RateLimit-Remaining` Number of requests remaining
- `Retry-After`: Number of seconds after which the client can retry
- `X-RateLimit-Reset`: Timestamp after which the client can retry

### Customizing the error response

You can customize the error message without handling the exception globally using the `limitExceeded` hook:
Expand Down