You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys, and pass it as
Authorization: Bearer <root key>. See Permission reference for every permission.data.passed is true only when every check passes. Each check’s result is in data.limits. If one check fails, none of the limits are charged. A deleted namespace anywhere in the list fails the whole request with 410 Gone and err:unkey:data:ratelimit_namespace_gone. Calls POST /v2/ratelimit.multiLimit. See Limit and multi-limit.
Usage
--body takes a JSON array, not an object.
Flags
string
required
JSON array of 1 to 100 checks, each with
namespace, identifier, limit, duration, and optional cost, the same fields ratelimit limit takes as flags.Shared flags
Everyunkey api command takes these. See CLI output and shared flags.
string
Root key used for the request. Falls back to
UNKEY_ROOT_KEY, then to the key stored by unkey auth login.string
default:"https://api.unkey.com"
Base URL of the API. Falls back to
UNKEY_API_BASE_URL. You don’t normally need to set it.string
default:"~/.unkey/config.toml"
Path of the config file written by
unkey auth login. Falls back to UNKEY_CONFIG.string
Output format. Falls back to
UNKEY_OUTPUT. json prints the full response. Any other value prints the request ID and data.string
Send this JSON as the whole request body instead of using the command’s flags. You can’t combine it with them.
Required permissions
ratelimit.*.limit, or ratelimit.<namespace_id>.limit for every namespace in the request. Namespaces created on first use also need ratelimit.*.create_namespace. See Root key permissions.
Examples
Two limits
Raw body