Knowledge Base

Gain greater control and improve your data security by setting rate limits, burst rates and quotas against individual API keys. Setting precise limits allows you to avoid unnecessary expense when the unexpected happens.

Rate Limit:
Throttling allows you to specify rate limits for your API key, determining the maximum number of requests it can make per second. This feature ensures that your API usage remains within acceptable levels, preventing traffic spikes that may overwhelm your system.

Burst Limit:
Burst rate settings can be applied, allowing you to limit the number of concurrent calls allowed per second for specific API Keys.

Quota:
Quotas allow you to set limits on the number of API calls that can be made within a given period using your API key. By configuring quotas, you can prevent excessive usage, optimise resource allocation, and manage costs effectively. Calls above the limit or quota will return a HTTP 429 (Too many requests) error.

1. From your Dashboard select API Admin > API Keys.

2. Click Generate API Key, add a project name then click Generate Key.

3. Select the settings icon against your chosen API key.

4. Click Limits and enable Throttling.

5. Add your Rate Limit per second.

6. Add your Burst Rate per second.

7. Enable Quota, add the number of calls and specify the time period.

8. Click Save.

9. Throttling and Quotas can be updated at any time.

10. Quotas will reset on the following schedule:

    24-hours: At midnight every day.
    1-week: At midnight every Sunday morning.
    1-month: At midnight on the 1st of the month.

    Note: Each time the quota is saved it will be reset.