rate-limits

List, inspect, create, update, and delete stored rate-limit rules. Staff access is required.

Commands

`list-rate-limits [OPTIONS]`	List paginated rules.
`get-rate-limit <UUID>`	Get one rule.
`create-rate-limit [OPTIONS]`	Create a rule.
`update-rate-limit [OPTIONS] <UUID>`	Update selected fields.
`delete-rate-limit <UUID>`	Delete a rule.

Examples

pearing-cli list-rate-limits --page 1 --per-page 50

pearing-cli create-rate-limit \
  --scope api:ping-user \
  --max-requests 10 \
  --window-seconds 60

pearing-cli update-rate-limit "$RATE_LIMIT_UUID" \
  --max-requests 20 \
  --window-seconds 120 \
  --is-enabled=false

pearing-cli delete-rate-limit "$RATE_LIMIT_UUID"

Create options

--scope <SCOPE>: unique instrumented operation, such as api:ping-user.
--max-requests <COUNT>: positive request count for each window.
--window-seconds <SECONDS>: positive window duration.
--is-enabled=<true|false>: optional; new rules default to enabled.

Enforcement

A rule is enforced only when both the rule and the site-wide rate_limits_enabled setting are enabled. Update options are optional and preserve omitted fields.