Skip to content

Commit 051deb0

Browse files
committed
Update rate limiting section to include webhook triggers and its snowflake behaviour
1 parent ec98a7e commit 051deb0

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

src/pages/docs/administration/managing-infrastructure/rate-limiting.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Rate limiting is configured using policies, managed in the **Configuration ➜ S
1919
![A screenshot of the rate limiting policies list screen. Three policies are shown, with varying configured values.](/docs/img/administration/managing-infrastructure/rate-limiting/policies-list.png)
2020
:::
2121

22-
There are three built-in policies:
22+
There are four built-in policies:
2323

2424
### Unauthenticated Requests
2525

@@ -36,6 +36,12 @@ The rate limit applies per user.
3636
This policy applies to any HTTP requests associated with an authenticated user which authenticate using an [agent API key](/docs/octopus-rest-api/how-to-create-an-api-key#creating-an-agent-api-key).
3737
The rate limit applies per user, counted separately from non-AI requests.
3838

39+
### Webhook Trigger Requests
40+
41+
This policy applies to any HTTP requests made to the [webhook runbook trigger](/docs/runbooks/webhook-runbook-trigger) endpoint.
42+
The rate limit applies per instance, shared across all webhook triggers.
43+
This policy is always enabled, and its rate and burst limit cannot be changed.
44+
3945
## Configuring the Rate limiter
4046

4147
You can use the configuration screen to enable or disable the rate limiting policies, and alter their configured values.
@@ -51,6 +57,10 @@ Each policy has the following settings you can modify:
5157
- **Rate**: The sustained rate of incoming HTTP requests that the limiter will allow. See [Understanding the Rate Limiter](#understanding-the-rate-limiter).
5258
- **Burst limit**: The number of requests that must be consumed before the rate limiter activates and starts rejecting them. See [Understanding the Rate Limiter](#understanding-the-rate-limiter).
5359

60+
:::div{.hint}
61+
The [Webhook Trigger Requests](#webhook-trigger-requests) policy is an exception; its settings cannot be modified.
62+
:::
63+
5464
Rate limiting policies can also be enabled and configured using the Octopus.Server command line's `rate-limiting-policy` command.
5565

5666
### Default Enabled State

0 commit comments

Comments
 (0)