Removal of inin-ratelimit-* response headers

Category: API

Summary: Removal of inin-ratelimit-* response headers

These HTTP response headers will no longer be returned:

  • inin-ratelimit-allowed
  • inin-ratelimit-count
  • inin-ratelimit-reset

On March 2019 a Developer Forum announcement was created to deprecate these HTTP response headers. At the same time the documentation was updated to mark these as deprecated. The headers will soon be removed from HTTP responses.

Context: The inin-ratelimit-* response headers are not always accurate and don't completely represent the rate limit(s) being applied to an API request. In most all cases more than one limit is applied to an API request. The inin-rate-limit-* headers only return one limit. This can be confusing to applications since headers may indicate the request was within the limit but a 429 response is returned.

Impact: Applications should not rely on the inin-ratelimit-* headers. Instead when applications receive a 429 HTTP response code they should use the retry-after header. The retry-after header returns the number of seconds until the request can be retried. For more information see this Developer Center article.

API limits can be found on the Developer Center and specific limits for your organization can be fetched through the API.

Date of Change: On or after 6/5/2021

Impacted APIs:
All APIs are impacted since these headers are added to every HTTP response.

References:
Original deprecation notice:

Documentation deprecation notice:
https://developer.mypurecloud.com/api/rest/rate_limits.html#deprecated_rate_limit_headers

Can you confirm the date of change is: June 5th? Since we have different standards for writing month-day

The headers will start being removed after June 5th, 2021. I'm am starting the process to remove them now so it will take a few days before they are fully removed from all regions.

Hi
After this change, I cant even see "retry-after" in the header of the response. Do I need to specify something in the request to get "retry-after"?

You only get a retry-after header when you're rate limited and the server instructs you with a specific time to retry. It's not there for successful requests and may not be there in some rate limiting cases. You can find recommendations for handling rate limits and other retryable requests here: https://developer.genesys.cloud/api/rest/rate_limits#retryable-requests

2 Likes

Perfect! Thank you :slight_smile:

This topic was automatically closed 62 days after the last reply. New replies are no longer allowed.