DataPower API Gateway only

Rate Limit

Use the Rate Limit policy to apply one or more rate or burst limits at any point in your API assembly flow. Rate and burst limits restrict the number of calls made to an API in a specified time period.

Gateway support

Table 1. Table showing which gateways support this policy, and the corresponding policy version
Gateway Policy version
DataPower® API Gateway, policy available from V2018.4.1.7 2.0.0

This topic describes how to configure the policy in the assembly user interface; for details on how to configure the policy in your OpenAPI source, see ratelimit.

About

The defined rate and burst limits are applied to whatever follows in the assembly flow. For example, if a Rate Limit policy is placed before an Invoke policy, and the call made by the Invoke policy exceeds the limits defined by the Rate Limit policy, the API call itself fails.

Note: For information about rate limits and burst limits in API Connect, see Understanding rate limits for APIs and Plans.

Properties

The following table lists the policy properties, indicates whether a property is required, specifies the valid and default values for input, and specifies the data type of the values.

Table 2. Rate Limit policy properties
Property label Required Description Data type
Title No The title of the policy.

The default value is ratelimit.

 string
Description No A description of the policy. string
Source Yes The location of all the rate limit and burst limit definitions that are included in this policy. Select one of the following options:
  • Catalog by Name: the limits to be applied are defined in the appropriate api-collection object on the DataPower API Gateway, which is the object that represents your API Connect Catalog in the gateway configuration.

    For details of how to configure a rate or burst limit in the api-collection object, see Configuring a rate or burst limit on the DataPower API Gateway.

  • Plan Default: the rate and burst limits that are applied are the default ones configured in the Plan to which the calling application is subscribed. For details on how to configure default Plan rate and burst limits, see Editing a draft Product.
 string
Rate Limit Name Yes1 The name of a rate limit as defined in the DataPower API Gateway configuration. To display the Rate Limit Name field, click Add Rate Limit; you can add as many rate limits as you want.

1You must provide at least one rate limit or at least one burst limit.

 string
Burst Limit Name Yes2 The name of a burst limit as defined in the DataPower API Gateway configuration. To display the Burst Limit Name field, click Add Burst Limit; you can add as many burst limits as you want.

2You must provide at least one rate limit or at least one burst limit.

 string