Update rate limit rule
Update an existing rate limit rule.
Update an existing rate limit rule.
ApiKeyAuthAuthorizationBearer <token>Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.
Required permission
manage_rate_limitsrule_id*stringuuidapplication/json- body
Fields that may be changed on an existing rate limit rule.
name?stringShort label for the rule, shown in the rule list.
description?|Optional note explaining what the rule protects against.
status?RateLimitRuleStatusWhether a rate limit rule is in effect.
"active""disabled"scope?What a rule matches.
key_by?array<>What a rule counts its budget per. Always includes org; add dimensions to subdivide that org-wide budget further, e.g. ["org", "user", "tool"] for a per-user-per-tool budget. Order does not matter — the list is canonicalised — but it must include org and be free of duplicates.
1 <= itemslimit?integerCalls allowed per window.
int321 <= valuewindow_seconds?integerLength of the window in seconds. Capped at one hour, the lifetime of the bucket that tracks it.
int321 <= value <= 3600burst?integerHow many calls may arrive at once before the rate applies. Also sets the granularity at which budget is released: each window admits max(burst, ceil(limit * min(1 minute, window_seconds) / window_seconds)) calls, and the window is however long that many calls take at the configured rate, never shorter than min(1 minute, window_seconds) — e.g. 1000/hour with no burst set derives a 61.2-second window admitting 17 calls, which is exactly 1000/hour. Defaults to 1. Must be at most limit.
int320 <= valueaction?RateLimitActionWhat happens to a call once a rule's budget is spent.
"deny""log_only"The request has succeeded.
application/json- response
A throughput limit on MCP tool calls. Every rule whose scope matches a call must have budget left, so rules compose rather than override one another — an org-wide ceiling and a tighter per-user one are both enforced. Counters live in each gateway process by default, so with several replicas the effective ceiling is the configured limit times the replica count; a deployment can instead share one counter across every process through NATS.
id*stringuuidname*stringShort label for the rule, shown in the rule list.
description?|Optional note explaining what the rule protects against.
status?RateLimitRuleStatusWhether a rate limit rule is in effect.
"active""disabled"scope*What a rule matches.
key_by*array<>What a rule counts its budget per. Always includes org; add dimensions to subdivide that org-wide budget further, e.g. ["org", "user", "tool"] for a per-user-per-tool budget. Order does not matter — the list is canonicalised — but it must include org and be free of duplicates.
1 <= itemslimit*integerCalls allowed per window.
int321 <= valuewindow_seconds*integerLength of the window in seconds. Capped at one hour, the lifetime of the bucket that tracks it.
int321 <= value <= 3600burst?integerHow many calls may arrive at once before the rate applies. Also sets the granularity at which budget is released: each window admits max(burst, ceil(limit * min(1 minute, window_seconds) / window_seconds)) calls, and the window is however long that many calls take at the configured rate, never shorter than min(1 minute, window_seconds) — e.g. 1000/hour with no burst set derives a 61.2-second window admitting 17 calls, which is exactly 1000/hour. Defaults to 1. Must be at most limit.
int320 <= valueaction?RateLimitActionWhat happens to a call once a rule's budget is spent.
"deny""log_only"created_at*stringdate-timeupdated_at*stringdate-timecurl -X PATCH "https://example.com/rate-limits/rules/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": null, "name": "string", "description": "string", "status": "active", "scope": { "type": "mcp_tool_call", "mcp_ids": [ "c2c9208c-a7ac-41cc-84f1-8c1caec92987" ], "agent_slugs": [ "string" ], "agent_instance_ids": [ "bc3f18ff-0dcd-4cc7-8f61-6ca61814f10b" ], "user_ids": [ "2d98503d-4ab4-41bd-8fc6-78cc006fd2db" ], "groups": [ "string" ], "agent_slug_tag_ids": [ "e428595a-d9dd-4887-8327-2d9cad5b7425" ], "mcp_tag_ids": [ "17d4a46c-d971-4171-9a66-88ec59ce6eeb" ], "tool_tag_ids": [ "41068329-9b4f-4cc3-b249-3ec2a7a2cee8" ], "tool_patterns": [ "string" ], "condition": "string", "condition_description": "string" }, "key_by": [ "org" ], "limit": 1, "window_seconds": 1, "burst": 0, "action": "deny", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}