Changing an API rate limit

When you activate an API to make it available for testing, as described in Activating an API, no rate limit is applied to restrict calls to the API. However, if desired, you can apply a rate limit to the API, or modify a previously applied rate limit. The rate limit defines the maximum number of calls allowed in a specified time period.

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.

API Manager UI only: To complete this task, you must be assigned a role that has the Api-Drafts:Edit permission. The pre-supplied Developer role has this permission by default; if you are assigned a custom role it must have this permission. For more information, see Creating custom roles.

Note:
  • For information about rate limits and burst limits in API Connect, see Understanding rate limits for APIs and Plans.
  • If you opted to use an automatically generated Product, you can configure a rate limit to control calls to the API. If you selected your own Product, the Target product rate limit option is not available; instead, the rate limits that are configured in the selected Product and Plan are applied. for more information, see Defining rate limits for an API operation.

Procedure

  1. In the navigation pane, click Develop icon in the API UI navigation pane Develop, then select the APIs tab.
  2. Click the title of the API that you want to work with.
  3. Select Test tab and click Target Configuration.
  4. On the Preferences page, locate the Target product rate limit and click Edit.
  5. Select Unlimited to allow unrestricted calls to the API, or select Custom to define the required rate limit; use the supplied fields to define the maximum number of calls allowed in a specified time period; for example, 100 calls per 1 minute.
    Note:
    The system clock determines the start time for rate, and burst limits. The intervals are configured as follows:
    • 1 second interval starts at each new second.
    • 1 minute interval starts at the beginning of each minute.
    • 1 hour interval starts at the beginning of each hour.
    • 1 day interval starts at midnight UTC.
    • 1 week interval starts on Thursday at 00:00:00 UTC.
  6. Click Choose Rate Limit when done.
  7. Click Save Preferences.

Results

You have successfully updated the rate limit period for the API.