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.
Usage
Flags
JSON array of rate limit check objects. Each object defines an independent rate limit check to perform.
Global Flags
| Flag | Type | Description |
|---|---|---|
--root-key | string | Override root key ($UNKEY_ROOT_KEY) |
--api-url | string | Override API base URL (default: https://api.unkey.com) |
--config | string | Path to config file (default: ~/.unkey/config.toml) |
--output | string | Output format — use json for raw JSON |
Examples
Output
Default output shows the request ID with latency, followed by the multi-limit result:--output=json, the full response envelope is returned:

