Defining rate limits for an API operation
For any Plan in a draft Product, you can apply one or more rate limits to a specific operation on any of the APIs in that Plan.
About this task
You can complete this task either by using the API Designer UI application, or by using the browser based API Manager UI.
During the initial creation of a Product, the Product creation wizard guides you to enter the minimum configuration settings, and then provides an Edit Product button. You have the option to specify additional configuration immediately, or to return to Product to edit it later. This topic describes how to specify additional configuration in either case.
Note: For information about rate limits and burst limits in API Connect, see Understanding rate limits for APIs and Plans.
Access the Product Setup page in one of the following ways:
- After completing the initial creation of the Product, click Edit Product.
- In the navigation pane, click Develop, then select the Products tab.
- Click the title of the Product that you want to edit.
- Click Plans.
- Click the options icon alongside the required Plan, then click Edit.
- Scroll down to the Plan APIs section, then select
Override plan rate limits for individual operation. The Override Rate Limits section is displayed.
- Click Add. The Override plan rate limits window opens.
- Select the API, and the specific operation in that API, to which you want to apply rate
limits. By default, calls to the operation are unlimited.
- To apply one or more rate limits to the operation, select Rate Limits.
- To define a rate limit, click Add.
- Supply a name for the rate limit, and define the maximum number of calls allowed in a specified time period; for example, 100 calls per 1 minute. If you select HARD LIMIT and the limit is exceeded, subsequent calls are rejected, otherwise calls are still accepted and a message is logged.
- Click Save when
done. An entry for the operation is listed in the Override Rate Limits section.
- To modify the rate limiting definition for an operation, click the options icon alongside the required operation, then click Edit Operation; to delete it, click Remove.
- Click Save to save your changes.