Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Aura divider
summaryRate Limiting
paramsJTdCJTIydHlwZSUyMiUzQSUyMnRleHQlMjIlMkMlMjJzdHlsZSUyMiUzQSU3QiUyMmFsaWdubWVudCUyMiUzQSU3QiUyMmhvcml6b250YWwlMjIlM0ElMjJjZW50ZXIlMjIlN0QlMkMlMjJpY29uJTIyJTNBJTdCJTIybmFtZSUyMiUzQSUyMmZhUGFwZXJQbGFuZSUyMiUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJkYXJrJTIyJTNBJTIyJTIzZGRkJTIyJTdEJTJDJTIyc2l6ZSUyMiUzQTI0JTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJkYXJrJTIyJTNBJTIyJTIzZGRkJTIyJTdEJTJDJTIyZm9udFNpemUlMjIlM0EzMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiUyQyUyMnRleHQlMjIlM0ElMjJSYXRlJTIwTGltaXRpbmclMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJ0b3AlMjIlM0FmYWxzZSUyQyUyMnJpZ2h0JTIyJTNBZmFsc2UlMkMlMjJib3R0b20lMjIlM0F0cnVlJTJDJTIybGVmdCUyMiUzQWZhbHNlJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyMzMzMyUyMiUyQyUyMmRhcmslMjIlM0ElMjIlMjNkZGQlMjIlN0QlMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTdEJTJDJTIyc2l6ZSUyMiUzQSU3QiU3RCU3RCU3RA==
Info

Customizable rate limiting is available to Data Center customers only. For Cloud customers, rate limiting is managed by Atlassian.

Aura divider
summaryMore Info
paramsJTdCJTIydHlwZSUyMiUzQSUyMnRleHQlMjIlMkMlMjJzdHlsZSUyMiUzQSU3QiUyMmFsaWdubWVudCUyMiUzQSU3QiUyMmhvcml6b250YWwlMjIlM0ElMjJjZW50ZXIlMjIlN0QlMkMlMjJpY29uJTIyJTNBJTdCJTIybmFtZSUyMiUzQSUyMmZhUGFwZXJQbGFuZSUyMiUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJkYXJrJTIyJTNBJTIyJTIzZGRkJTIyJTdEJTJDJTIyc2l6ZSUyMiUzQTI0JTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJkYXJrJTIyJTNBJTIyJTIzZGRkJTIyJTdEJTJDJTIyZm9udFNpemUlMjIlM0ExOCUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiUyQyUyMnRleHQlMjIlM0ElMjJNb3JlJTIwSW5mbyUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQWZhbHNlJTJDJTIycmlnaHQlMjIlM0FmYWxzZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBZmFsc2UlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMzMzJTIyJTJDJTIyZGFyayUyMiUzQSUyMiUyM2RkZCUyMiU3RCUyQyUyMnN0eWxlJTIyJTNBJTIyc29saWQlMjIlMkMlMjJ3aWR0aCUyMiUzQTElN0QlMkMlMjJzaXplJTIyJTNBJTdCJTdEJTdEJTdE

Rate limiting controls the number of requests users can make to the API within a specified time frame on a node. Enabling this feature helps prevent excessive usage and ensures fair access to the API for all users in your environment.

Table of Contents
minLevel2
maxLevel6
outlinefalse
typelist
printablefalse
Aura divider
summaryAura Divider
paramsJTdCJTIydHlwZSUyMiUzQSUyMmljb24lMjIlMkMlMjJzdHlsZSUyMiUzQSU3QiUyMmFsaWdubWVudCUyMiUzQSU3QiUyMmhvcml6b250YWwlMjIlM0ElMjJjZW50ZXIlMjIlN0QlMkMlMjJpY29uJTIyJTNBJTdCJTIybmFtZSUyMiUzQSUyMmZhLWNoYXJ0LWxpbmUlMjIlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMzMzJTIyJTJDJTIyZGFyayUyMiUzQSUyMiUyM2RkZCUyMiU3RCUyQyUyMnNpemUlMjIlM0EyNCU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMzMzJTIyJTJDJTIyZGFyayUyMiUzQSUyMiUyM2RkZCUyMiU3RCUyQyUyMmZvbnRTaXplJTIyJTNBMTQlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmJvbGQlMjIlMkMlMjJ0ZXh0JTIyJTNBJTIyQXVyYSUyMERpdmlkZXIlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJ0b3AlMjIlM0FmYWxzZSUyQyUyMnJpZ2h0JTIyJTNBZmFsc2UlMkMlMjJib3R0b20lMjIlM0F0cnVlJTJDJTIybGVmdCUyMiUzQWZhbHNlJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyMzMzMyUyMiUyQyUyMmRhcmslMjIlM0ElMjIlMjNkZGQlMjIlN0QlMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTdEJTJDJTIyc2l6ZSUyMiUzQSU3QiU3RCU3RCU3RA==

Enable Rate Limiting

  1. In the Custom Charts app Admin Settings, click the Performance Options tab

  2. In the Rate Limit Options section, click the Enable rate limit toggle so that it turns green


Rate Limit Options

Option

What does it do?

How do I update this?

Rate limit refill rate

Defaults to 20

Determines how quickly user’s rate limit quota replenishes. It specifies the number of requests users regains per unit of time.

Click into the “20” text box and type in a new number

Rate limit refill time

Defaults to 1 second

Refers to the time interval used to measure the rate limit refill in conjunction with the refill rate. When users reach or exceed the rate limit, they need to wait until the refill time elapses. During this waiting period, users won’t be able to make additional requests. The refill process continues until the capacity or quota is fully replenished, allowing users to resume making requests within the specified limits.

Click into the “1” textbox and type in a new number, then change the “Seconds” dropdown if you’d prefer a different time unit

For the time unit, you options are:

Rate limit burst capacity

Defaults to 50

This number sets the maximum number of requests allowed without any refill. It represents the size of the bucket that holds user’s available request quota.

Click into the “50” textbox and type in a new number

Apply Rate Limit

Clicking this button will instantly enforce the specified rate limit settings. It ensures that the defined restrictions on the number of requests users can make within a given time frame are applied immediately. Otherwise changes to rate limit settings may take a few minutes before they are applied.

Aura divider
summaryAura Divider
paramsJTdCJTIydHlwZSUyMiUzQSUyMmljb24lMjIlMkMlMjJzdHlsZSUyMiUzQSU3QiUyMmFsaWdubWVudCUyMiUzQSU3QiUyMmhvcml6b250YWwlMjIlM0ElMjJjZW50ZXIlMjIlN0QlMkMlMjJpY29uJTIyJTNBJTdCJTIybmFtZSUyMiUzQSUyMmZhLWNoYXJ0LWNvbHVtbiUyMiUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJkYXJrJTIyJTNBJTIyJTIzZGRkJTIyJTdEJTJDJTIyc2l6ZSUyMiUzQTE4JTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJkYXJrJTIyJTNBJTIyJTIzZGRkJTIyJTdEJTJDJTIyZm9udFNpemUlMjIlM0ExNCUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIyYm9sZCUyMiUyQyUyMnRleHQlMjIlM0ElMjJBdXJhJTIwRGl2aWRlciUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQWZhbHNlJTJDJTIycmlnaHQlMjIlM0FmYWxzZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBZmFsc2UlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMzMzJTIyJTJDJTIyZGFyayUyMiUzQSUyMiUyM2RkZCUyMiU3RCUyQyUyMnN0eWxlJTIyJTNBJTIyc29saWQlMjIlMkMlMjJ3aWR0aCUyMiUzQTElN0QlMkMlMjJzaXplJTIyJTNBJTdCJTdEJTdEJTdE

FAQs


How do I know if the rate limit has been reached?

Why would I enable rate limiting?

Expand
titleClick here to learn more

While the Dashboard is loading, the error message below will appear on Custom Charts gadgets.

Image Modified

Why would I enable rate limiting?

Expand
titleClick here to learn more

If you have a large Jira instance, or, are using complex JQL queries on your Dashboards, and you are having performance issues, rate limiting is recommended.

Can I impose limits on specific users only?

Expand
titleClick here to learn more

No, it is not possible to limit only specific users. If an account is a heavy user of the API, they will be limited. As rate-limiting is a per-user limit, only those who are heavy users will be impacted.

Aura divider
summaryAura Divider
paramsJTdCJTIydHlwZSUyMiUzQSUyMmljb24lMjIlMkMlMjJzdHlsZSUyMiUzQSU3QiUyMmFsaWdubWVudCUyMiUzQSU3QiUyMmhvcml6b250YWwlMjIlM0ElMjJjZW50ZXIlMjIlN0QlMkMlMjJpY29uJTIyJTNBJTdCJTIybmFtZSUyMiUzQSUyMmZhLWNoYXJ0LXBpZSUyMiUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJkYXJrJTIyJTNBJTIyJTIzZGRkJTIyJTdEJTJDJTIyc2l6ZSUyMiUzQTE4JTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJkYXJrJTIyJTNBJTIyJTIzZGRkJTIyJTdEJTJDJTIyZm9udFNpemUlMjIlM0ExNCUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIyYm9sZCUyMiUyQyUyMnRleHQlMjIlM0ElMjJBdXJhJTIwRGl2aWRlciUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQWZhbHNlJTJDJTIycmlnaHQlMjIlM0FmYWxzZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBZmFsc2UlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMzMzJTIyJTJDJTIyZGFyayUyMiUzQSUyMiUyM2RkZCUyMiU3RCUyQyUyMnN0eWxlJTIyJTNBJTIyc29saWQlMjIlMkMlMjJ3aWR0aCUyMiUzQTElN0QlMkMlMjJzaXplJTIyJTNBJTdCJTdEJTdEJTdE

Aura inline button
summaryYouTube Tutorials
paramsJTdCJTIybGFiZWwlMjIlM0ElMjJZb3VUdWJlJTIwVHV0b3JpYWxzJTIyJTJDJTIyc2l6ZSUyMiUzQSUyMnNtYWxsJTIyJTJDJTIyc2hhcGUlMjIlM0ElMjJjaXJjdWxhciUyMiUyQyUyMnN0YXRlcyUyMiUzQSU3QiUyMmlkbGUlMjIlM0ElN0IlMjJjb2xvcnMlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kJTIyJTNBJTIyJTIzZmYwMDAwJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJjb2xvcnMlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kJTIyJTNBJTIyJTIzZmZmZmZmJTIyJTJDJTIybGFiZWwlMjIlM0ElMjIlMjNmZjAwMDAlMjIlMkMlMjJvdXRsaW5lJTIyJTNBJTIyJTIzZmYwMDAwJTIyJTdEJTdEJTdEJTJDJTIyaWNvbiUyMiUzQSU3QiUyMnBvc2l0aW9uJTIyJTNBJTIybGVmdCUyMiUyQyUyMmljb24lMjIlM0ElMjJmYS15b3V0dWJlJTIyJTdEJTJDJTIybGluayUyMiUzQSU3QiUyMnR5cGUlMjIlM0ElMjJsaW5rJTIyJTJDJTIydmFsdWUlMjIlM0ElMjJodHRwcyUzQSUyRiUyRnd3dy55b3V0dWJlLmNvbSUyRiU0ME9sZFN0cmVldFNvbHV0aW9ucyUyMiUyQyUyMnRhcmdldCUyMiUzQSUyMl9ibGFuayUyMiU3RCU3RA==
Aura inline button
summaryContact Support
paramsJTdCJTIybGFiZWwlMjIlM0ElMjJDb250YWN0JTIwU3VwcG9ydCUyMiUyQyUyMnNpemUlMjIlM0ElMjJzbWFsbCUyMiUyQyUyMnNoYXBlJTIyJTNBJTIyY2lyY3VsYXIlMjIlMkMlMjJzdGF0ZXMlMjIlM0ElN0IlMjJpZGxlJTIyJTNBJTdCJTIyY29sb3JzJTIyJTNBJTdCJTIyYmFja2dyb3VuZCUyMiUzQSUyMiUyMzI2ODRmZiUyMiUyQyUyMmxhYmVsJTIyJTNBJTIyJTIzZmZmZmZmJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJjb2xvcnMlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kJTIyJTNBJTIyJTIzZmZmZmZmJTIyJTJDJTIyb3V0bGluZSUyMiUzQSUyMiUyMzI2ODRmZiUyMiUyQyUyMmxhYmVsJTIyJTNBJTIyJTIzMjY4NGZmJTIyJTdEJTdEJTdEJTJDJTIyaWNvbiUyMiUzQSU3QiUyMnBvc2l0aW9uJTIyJTNBJTIybGVmdCUyMiUyQyUyMmljb24lMjIlM0ElMjJmYS1xdWVzdGlvbiUyMiU3RCUyQyUyMmxpbmslMjIlM0ElN0IlMjJ0eXBlJTIyJTNBJTIybGluayUyMiUyQyUyMnZhbHVlJTIyJTNBJTIyaHR0cHMlM0ElMkYlMkZ0ZW1wby1pby5hdGxhc3NpYW4ubmV0JTJGc2VydmljZWRlc2slMkZjdXN0b21lciUyRnBvcnRhbCUyRjYlMkZncm91cCUyRjEwNjUlMkZjcmVhdGUlMkY0NSUyMiU3RCU3RA==
Aura inline button
summaryMarketplace Listing
paramsJTdCJTIybGFiZWwlMjIlM0ElMjJNYXJrZXRwbGFjZSUyMExpc3RpbmclMjIlMkMlMjJzaXplJTIyJTNBJTIyc21hbGwlMjIlMkMlMjJzaGFwZSUyMiUzQSUyMmNpcmN1bGFyJTIyJTJDJTIyc3RhdGVzJTIyJTNBJTdCJTIyaWRsZSUyMiUzQSU3QiUyMmNvbG9ycyUyMiUzQSU3QiUyMmJhY2tncm91bmQlMjIlM0ElMjIlMjM2NTU0YzAlMjIlMkMlMjJsYWJlbCUyMiUzQSUyMiUyM2ZmZmZmZiUyMiU3RCU3RCUyQyUyMmhvdmVyJTIyJTNBJTdCJTIyY29sb3JzJTIyJTNBJTdCJTIyYmFja2dyb3VuZCUyMiUzQSUyMiUyM2ZmZmZmZiUyMiUyQyUyMm91dGxpbmUlMjIlM0ElMjIlMjMyNjg0ZmYlMjIlMkMlMjJsYWJlbCUyMiUzQSUyMiUyMzI2ODRmZiUyMiU3RCU3RCU3RCUyQyUyMmxpbmslMjIlM0ElN0IlMjJ0eXBlJTIyJTNBJTIybGluayUyMiUyQyUyMnZhbHVlJTIyJTNBJTIyaHR0cHMlM0ElMkYlMkZtYXJrZXRwbGFjZS5hdGxhc3NpYW4uY29tJTJGYXBwcyUyRjEyMjA5MjUlMkZjdXN0b20tY2hhcnRzLWZvci1qaXJhLXJlcG9ydHMlM0Zob3N0aW5nJTNEY2xvdWQlMjZ1dG1fdGVybSUzRCUyNnV0bV9jYW1wYWlnbiUzREN1c3RvbSUyQkNoYXJ0cyUyQi0lMkJTZWFyY2glMkJBZHMlMjZ1dG1fc291cmNlJTNEYWR3b3JkcyUyNnV0bV9tZWRpdW0lM0RwcGMlMjZoc2FfYWNjJTNEMzQ1NzMyMzY5NiUyNmhzYV9jYW0lM0QyMDM4NzMxMjQ0JTI2aHNhX2dycCUzRDEyNzgwOTA0NjMxNSUyNmhzYV9hZCUzRDYwMTEzOTAxNTQxNCUyNmhzYV9zcmMlM0RnJTI2aHNhX3RndCUzRGF1ZC05MDA0NTY3ODc0MjAlM0Fkc2EtMTQxNzY3NjAzMjI5NSUyNmhzYV9rdyUzRCUyNmhzYV9tdCUzRCUyNmhzYV9uZXQlM0RhZHdvcmRzJTI2aHNhX3ZlciUzRDMlMjZnY2xpZCUzREVBSWFJUW9iQ2hNSXZ1cm9xY0dEX1FJVlZSUFVBUjA3ZmdRa0VBQVlBU0FBRWdMWkxmRF9Cd0UlMjIlMkMlMjJ0YXJnZXQlMjIlM0ElMjJfYmxhbmslMjIlN0QlMkMlMjJpY29uJTIyJTNBJTdCJTIycG9zaXRpb24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyaWNvbiUyMiUzQSUyMmZhLWNhcnQtYXJyb3ctZG93biUyMiU3RCU3RA==