Skip to content

Commit 4a12529

Browse files
committed
plus_rate_limiting
1 parent 71c0f9b commit 4a12529

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### `plus.rate_limiting`
2+
3+
This section specifies the rate limiting for the API server.
4+
The entire section is optional.
5+
If not specified, the listed default values will be used.
6+
7+
To prevent [`unclaimed` projects][unclaimed projects] from being created,
8+
set the `unclaimed_limit` to `0`.
9+
10+
| Name | Example | Default | Required | Description |
11+
| :-------------: | :-----: | :-----: | :------: | :---------------------------------------------------------------------------------------------------------------------------------------------------: |
12+
| window | 86400 | 86400 | No | Specifies the rate limiting window in seconds. Set to one day by default. |
13+
| user_limit | 255 | 255 | No | Controls the rate limiting for certain resources created by a user: Organizations and API tokens. |
14+
| unclaimed_limit | 255 | 255 | No | Controls the rate limiting for [`unclaimed` projects][unclaimed projects]. To prevent `unclaimed` projects from being created, set this value to `0`. |
15+
| claimed_limit | 65536 | 65536 | No | Controls the rate limiting for `claimed` projects. |
16+
17+
[unclaimed projects]: /docs/how-to/claim/#unclaimed-projects

services/console/src/chunks/docs-reference/server-config/en/plus.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import PlusGitHub from "./plus-github.mdx";
22
import PlusDisasterRecovery from "./plus-disaster-recovery.mdx";
3+
import PlusRateLimiting from "./plus-rate-limiting.mdx";
34
import PlusStats from "./plus-stats.mdx";
45

56
## `plus`
@@ -8,4 +9,5 @@ This section is for features that are covered by the [Bencher Plus License](/leg
89

910
<PlusGitHub />
1011
<PlusDisasterRecovery />
12+
<PlusRateLimiting />
1113
<PlusStats />

services/console/src/chunks/docs-reference/server-config/example.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@
5555
}
5656
]
5757
},
58+
"rate_limiting": {
59+
"window": 86400,
60+
"user_limit": 255,
61+
"unclaimed_limit": 255,
62+
"claimed_limit": 65536,
63+
},
5864
"stats": {
5965
"offset": 11242,
6066
"enabled": true

0 commit comments

Comments
 (0)