Api Limit Policies Retrieve

GET

https://api.respan.ai/api/limit-policies/:id/

GET

/api/limit-policies/:id/

$ curl https://api.respan.ai/api/limit-policies/id/ \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": "string",
3   "name": "string",
4   "scope": "string",
5   "scope_value": "string",
6   "compose": null,
7   "metric": "cost",
8   "algorithm": "balance_fixed_window",
9   "period": "string",
10   "effective_at": "2024-01-15T09:30:00Z",
11   "expires_at": "2024-01-15T09:30:00Z",
12   "priority": 1,
13   "is_active": true,
14   "threshold_value": 1.1,
15   "meter_definition_id": "string",
16   "updated_by": {
17     "id": 1,
18     "email": "string",
19     "name": "string",
20     "username": "string",
21     "first_name": "string",
22     "last_name": "string"
23   },
24   "created_at": "2024-01-15T09:30:00Z",
25   "updated_at": "2024-01-15T09:30:00Z",
26   "current_state": {
27     "meter_id": "string",
28     "interval_start": 1,
29     "interval_end": 1,
30     "current_value": 1.1
31   },
32   "tags": [
33     {
34       "id": "string",
35       "name": "string",
36       "color": "string",
37       "created_at": "2024-01-15T09:30:00Z",
38       "updated_at": "2024-01-15T09:30:00Z"
39     }
40   ],
41   "rules": null,
42   "anchor": "calendar",
43   "anchor_at": "2024-01-15T09:30:00Z",
44   "refill_rate": 1.1
45 }

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.

Authentication

AuthorizationBearer

JWT access token or Respan API key

Path parameters

idstringRequired

Response

idstringRead-only

namestringRead-only

scopestringRead-only

scope_valuestringRead-only

composeanyRead-only

metricenum

cost - Cost
request_count - Request count
token_count - Token count

algorithmenum

balance_fixed_window - Balance fixed window
token_bucket - Token bucket

periodstring or nullRead-only

effective_atdatetime or nullRead-only

expires_atdatetime or nullRead-only

priorityintegerRead-only

is_activebooleanRead-only

threshold_valuedoubleRead-only

meter_definition_idstringRead-only

updated_byobject

created_atdatetimeRead-only

updated_atdatetimeRead-only

current_stateobject

Live counter state for the policy’s current window. Sourced from Redis (same key apply_limits evaluates against). Populated by the view’s bulk prefetch on list responses; falls back to a single HGET on detail.

tagslist of objectsRead-only

GenericTag rows assigned to this policy. Managed via /api/tag-assignments/limit_policies/... — read-only here.

rulesanyRead-only

anchorenum

calendar - Calendar
first_event - First event
explicit_ts - Explicit timestamp

anchor_atdatetime or nullRead-only

refill_ratedouble or nullRead-only