Skip to content

Clarify per-user rate limit override documentation #19950

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

Open
aouxwoux wants to merge 1 commit into
base: develop
Choose a base branch
from
+19 −18
Open

Clarify per-user rate limit override documentation #19950

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
37 changes: 19 additions & 18 deletions docs/admin_api/user_admin_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1311,10 +1311,11 @@ The following parameters should be set in the URL:

## Override ratelimiting for users

This API allows to override or disable ratelimiting for a specific user.
There are specific APIs to set, get and delete a ratelimit.
This API allows an administrator to set, retrieve, or remove a message rate limit
override for a specific user. Removing an override restores the configured default
rate limit.

### Get status of ratelimit
### Get message rate limit override

The API is:

Expand Down Expand Up @@ -1342,18 +1343,18 @@ The following parameters should be set in the URL:

The following fields are returned in the JSON response body:

- `messages_per_second` - integer - The number of actions that can
be performed in a second. `0` mean that ratelimiting is disabled for this user.
- `burst_count` - integer - How many actions that can be performed before
being limited.
- `messages_per_second` - integer - The number of messages that can be sent per
second. `0` means that ratelimiting is disabled for this user.
- `burst_count` - integer - The number of messages that can be sent before the user
is limited.

If **no** custom ratelimit is set, an empty JSON dict is returned.

```json
{}
```

### Set ratelimit
### Set message rate limit override

The API is:

Expand All @@ -1379,23 +1380,23 @@ The following parameters should be set in the URL:

Body parameters:

- `messages_per_second` - positive integer, optional. The number of actions that can
be performed in a second. Defaults to `0`.
- `burst_count` - positive integer, optional. How many actions that can be performed
before being limited. Defaults to `0`.
- `messages_per_second` - non-negative integer, optional. The number of messages that can
be sent per second. Defaults to `0`.
- `burst_count` - non-negative integer, optional. The number of messages that can be sent
before the user is limited. Defaults to `0`.

To disable users' ratelimit set both values to `0`.
To disable a user's rate limit, set both values to `0`.

**Response**

The following fields are returned in the JSON response body:

- `messages_per_second` - integer - The number of actions that can
be performed in a second.
- `burst_count` - integer - How many actions that can be performed before
being limited.
- `messages_per_second` - integer - The number of messages that can be sent per
second.
- `burst_count` - integer - The number of messages that can be sent before the user
is limited.

### Delete ratelimit
### Delete message rate limit override

The API is:

Expand Down
Loading