Include "Retry-After" and "X-RateLimit" headers for Assets REST API

XMLWordPrintable

    • 15
    • 10

      Problem Definition

      Assets rate limiting differs to the rate limiting implemented within Jira Cloud in that for the Assets REST API a certain number of requests within a minute are permitted while Jira Cloud uses a a cost based rate limiting associated with a user or a Connect application for example.

      Relating to Assets REST API:

      Rate limiting
      All endpoints are rate-limited to 1,000 requests per minute per instance with a total limit of 10,000 requests per minute per instance. Any exceptions to this rule will be mentioned in the documentation of the individual endpoints.

      Currently no information is provided when rate limiting is triggered (HTTP 429 response) or service resources are met (HTTP 503 response) to the client making the requests as to when they should continue sending requests. Providing the headers would help developers handle rate limit scenarios.

      Suggested Solution

      Include the Retry-After or X-RateLimit-Reset headers when Assets REST API hits rate limiting or service limits.

            Assignee:
            Atul Arohi
            Reporter:
            Atiqah Roslan
            Votes:
            27 Vote for this issue
            Watchers:
            18 Start watching this issue

              Created:
              Updated: