API Explorer

v5.1.0 filtered by tag: Rate-Limits (2 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Rate Limiting Info

Get information about the Rate Limiting setup on this OBP Instance such as:

Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).

Note: Rate limiting can be set at the Consumer level and also for anonymous calls.

See the consumer rate limits / call limits endpoints.

Authentication is Mandatory

JSON response body fields:

enabled: false

is_active: false

service_available:

technology: technology1

Typical Successful Response:

								
									
{ "enabled":true, "technology":"REDIS", "service_available":true, "is_active":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Version: OBPv3.1.0, function_name: by getRateLimitingInfo, operation_id: OBPv3.1.0-getRateLimitingInfo Tags: API, Rate-Limits,

Set Rate Limits / Call Limits per Consumer

Set the API rate limits / call limits for a Consumer:

Rate limiting can be set:

Per Second
Per Minute
Per Hour
Per Week
Per Month

Authentication is Mandatory

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

from_date:

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:

to_date:

api_name: api_name

api_version:

bank_id: gh.29.uk

Typical Successful Response:

								
									
{ "from_date":"1100-01-01T00:00:00Z", "to_date":"1100-01-01T00:00:00Z", "per_second_call_limit":"-1", "per_minute_call_limit":"-1", "per_hour_call_limit":"-1", "per_day_call_limit":"-1", "per_week_call_limit":"-1", "per_month_call_limit":"-1" }
Required Roles:
  • CanSetCallLimits - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by callsLimit, operation_id: OBPv4.0.0-callsLimit Tags: Consumer, Rate-Limits,