Use this file to discover all available pages before exploring further.
Check and enforce multiple rate limits in a single request for any identifiers (user IDs, IP addresses, API clients, etc.).Use this to efficiently check multiple rate limits at once. Each rate limit check is independent and returns its own result with a top-level passed indicator showing if all checks succeeded.Response Codes: Rate limit checks return HTTP 200 regardless of whether limits are exceeded — check the passed field to see if all limits passed, or the success field in each individual result. A 429 may be returned if the workspace exceeds its API rate limit. Other 4xx responses indicate auth, namespace existence/deletion, or validation errors (e.g., 410 Gone for deleted namespaces). 5xx responses indicate server errors.Required permissions:
ratelimit.*.limit (to check limits in any namespace)
ratelimit.<namespace_id>.limit (to check limits in all specific namespaces being checked)
See the API reference for the full HTTP endpoint documentation.
Defines the scope of rate limiting by identifying the entity being limited. Use user IDs for per-user limits, IP addresses for anonymous limiting, or API key IDs for per-key limits. The same identifier can be used across different namespaces to apply multiple rate limit types. Must be 1-255 characters.
Sets the maximum operations allowed within the duration window before requests are rejected. When this limit is reached, subsequent requests fail until the window resets. Minimum: 1.
Sets the rate limit window duration in milliseconds after which the counter resets. Common values include 60000 (1 minute), 3600000 (1 hour), and 86400000 (24 hours). Range: 1,000-2,592,000,000 (1 second to 30 days).
Sets how much of the rate limit quota this request consumes, enabling weighted rate limiting. Use higher values for resource-intensive operations and 0 for tracking without limiting. Minimum: 0.
