Get Rate Limits for all Consumers
GET /obp/v7.0.0/management/rate-limits
OBPv7.0.0-getConsumerRateLimits Roles: CanReadCallLimits Rate-LimitsConsumerAPI
Returns every per-consumer rate limit row on this instance, across all Consumers, sorted by Consumer name.
These rows are what override the consumer limiter's defaults (see Get Rate Limiter Config, whose consumer_default row applies
to a Consumer with no rows of its own). is_active is whether from_date..to_date covers now. api_version, api_name
and bank_id narrow a row to one endpoint or bank; all absent means the row applies to every call the Consumer makes.
-1 means unlimited and 0 blocks every call.
For one Consumer's rows use Get Rate Limits for a Consumer (v5.1.0); to change them use the v6.0.0 endpoints.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (15)
- consumer_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- consumer_name
- consumer_name
- created_at
- created_at
- from_date
- 1100-01-01T01:01:01.000Z
- is_active
- false
- per_day_call_limit
- per_hour_call_limit
- per_minute_call_limit
- per_month_call_limit
- per_second_call_limit
- 10
- per_week_call_limit
- rate_limiting_id
- rate_limiting_id
- rate_limits
- rate_limits
- to_date
- 1100-01-01T01:01:01.000Z
- updated_at
- updated_at
Example success response
{
"rate_limits": [
{
"rate_limiting_id": "2f1b6c0e-9d5a-4c3b-8e7f-1a2b3c4d5e6f",
"consumer_id": "8e716299-4668-4efd-976a-67f57a9984ec",
"consumer_name": "Mobile App",
"from_date": "1100-01-01T00:00:00Z",
"to_date": "1100-01-01T00:00:00Z",
"is_active": true,
"per_second_call_limit": "-1",
"per_minute_call_limit": "-1",
"per_hour_call_limit": "1000",
"per_day_call_limit": "10000",
"per_week_call_limit": "-1",
"per_month_call_limit": "-1",
"created_at": "1100-01-01T00:00:00Z",
"updated_at": "1100-01-01T00:00:00Z"
}
]
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.