Rate Limit Info

Use the Rate Limit Info policy to return information about rate limits, burst limits, and count limits. Rate and burst limits restrict the number of calls made to an API in a specified time period, while count limits impose a strict limit on the total number of calls.

Gateway support

Table 1. Table showing which gateways support this policy, and the corresponding policy version
Gateway	Policy version
DataPower® API Gateway	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 ratelimitinfo.

About

The Rate Limit Info policy returns information about the rate limits, burst limits, and count limits that are applied to the API.

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 Info policy properties
Property label	Required	Description	Data type
Title	No	The title of the policy. The default value is `ratelimitinfo`.	string
Description	No	A description of the policy.	string
Input	No	The input context that specifies what rate limit information is requested.	string
Output	No	The destination of rate limit information.	string