ratelimitinfo

Use the ratelimitinfo 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 your OpenAPI source; for details on how to configure the policy in the assembly user interface, see Rate Limit Info.

About

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

The ratelimitinfo policy has the following format:

- ratelimitinfo:
    version: version
    title: title
    description: description
    input: input_context
    output: output_location

Properties

The following table describes the properties of the ratelimitinfo policy.

Table 2. ratelimitinfo policy properties
Property	Required	Description	Data type
version	Yes	The policy version number	string
title	No	A title for the policy.	string
description	No	A policy description.	string
input	No	The input context that specifies what rate limit information is requested.	string
output	No	The destination of rate limit information.	string