CLICommands
rate-limit
snug rate-limit <COMMAND>Rate limit administration (tiers, modules, endpoints, users, self-serve limits).
Subcommands
| Command | What it does |
|---|---|
config | View the full rate limit configuration |
me | View the calling principal's effective rate limit budget |
get-default | Get the default rate limit tier |
update-default | Update the default rate limit tier |
list-modules | List module rate limit tiers |
create-module | Create a module rate limit tier |
get-module | Get a module rate limit tier |
update-module | Update a module rate limit tier |
delete-module | Delete a module rate limit tier |
list-endpoints | List endpoint rate limit tiers |
create-endpoint | Create an endpoint rate limit tier |
get-endpoint | Get an endpoint rate limit tier |
update-endpoint | Update an endpoint rate limit tier |
delete-endpoint | Delete an endpoint rate limit tier |
list-users | List user rate limit configurations |
create-user | Create a user rate limit configuration |
get-user | Get a user's rate limit configuration |
update-user | Update a user's rate limit configuration |
delete-user | Delete a user's rate limit configuration |
list-tiers | List support tiers |
create-tier | Create a support tier |
get-tier | Get a support tier |
update-tier | Update a support tier |
delete-tier | Delete a support tier |
clear-cache | Clear the rate limit configuration cache |
Run snug rate-limit <command> --help for that command's own options.
The global options apply everywhere.
Examples
snug rate-limit config
snug rate-limit me
snug rate-limit me -e /api/v1/geo/search
snug rate-limit get-default
snug rate-limit update-default -r 200 -w 60
snug rate-limit list-modules
snug rate-limit create-module -m geo -r 500 -w 60
snug rate-limit update-module -m geo -r 750 -w 60
snug rate-limit get-module -m geo
snug rate-limit delete-module -m geo
snug rate-limit list-endpoints
snug rate-limit create-endpoint -e /api/v1/geo/search -r 150 -w 60
snug rate-limit get-endpoint -e /api/v1/geo/search
snug rate-limit update-endpoint -e /api/v1/geo/search -r 200 -w 60
snug rate-limit delete-endpoint -e /api/v1/geo/search
snug rate-limit list-users --limit 100
snug rate-limit create-user -u user123 -t premium
snug rate-limit get-user -u user123
snug rate-limit update-user -u user123 -t premium --bypass
snug rate-limit delete-user -u user123
snug rate-limit list-tiers
snug rate-limit create-tier -n vip -r 5000 -w 60 -d 'VIP tier'
snug rate-limit get-tier -n vip
snug rate-limit update-tier -n vip -r 6000 -w 60
snug rate-limit delete-tier -n vip
snug rate-limit clear-cacheNext
- Related guide - the concepts behind these commands.
- CLI reference - global options, output modes, and exit codes.