API Group Usage Control

API Group Usage Control is based on a rate limit design. Each customer group has a default API usage limit set to 360 requests every hour. The API usage limit can be changed on the API Group Usage Control page.

Note: If the API usage limit is increased, depending on AMM resources, the API response time to return the requested information may be longer.

Changing the API Usage Limit

Follow the steps below to change the API Usage Limit:

1. Select Develop->API Group Usage Control.

2. Select the name of the Group that you wish to change.

3. Set the Global usage limit. The value must be greater than 0, and less than 100000.

4. Select Save.

For auditability, the change is recorded in the Admin -> User Activity logs.

Note: The API usage limit does not follow the AMM group inheritance model. The customer (owner group) usage limit will not inherit or be limited by its parent groups.

Note: For on-premise AMMs, where the API clients are managed by admin or an admin like user, the All Gateways group is not selectable and therefore the usage limit is not adjustable. See Adjusting Usage Limit for All Gateways for more detail.

Response when usage limit reached

If a request is rejected due to the usage limit being reached, the standard HTTP “429 Too Many Requests” response is returned to the caller.

HTTP Response Header	Description	Example
X-Rate-Limit-Remaining	Included when request has not yet reached rate limit, and indicates how many requests can be made in the current hour.	X-Rate-Limit-Remaining: 998
X-Rate-Limit-Retry-After-Seconds	Included when request has exceeded rate limit, and indicates how many seconds API client has to wait in order to make a request again.	X-Rate-Limit-Retry-After-Seconds: 126