Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
platformApi

Api Limit Policies Retrieve

GET/PATCH/DELETE /api/limit-policies/<id>/

Detail is PG-only. Live counters live on the /list/ route (dashboard context). The detail view is for editing config.

get/api/limit-policies/{id}/

Path parameters

idstring required

Headers

Authorizationstring required

JWT access token or Respan API key

Response

idstring required
namestring required
scopestring required
scope_valuestring required
composestring[] required
metric'cost' | 'request_count' | 'token_count' required
  • cost - Cost
  • request_count - Request count
  • token_count - Token count
algorithm'balance_fixed_window' | 'token_bucket' required
  • balance_fixed_window - Balance fixed window
  • token_bucket - Token bucket
periodstring nullable required
effective_atstring date-time nullable required
expires_atstring date-time nullable required
priorityinteger required
is_activeboolean required
threshold_valuenumber double required
meter_definition_idstring required
created_atstring date-time required
updated_atstring date-time required
rulesobject[] required
anchor'calendar' | 'first_event' | 'explicit_ts' required
  • calendar - Calendar
  • first_event - First event
  • explicit_ts - Explicit timestamp
anchor_atstring date-time nullable required
refill_ratenumber double nullable required