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.
Enable Rate Limiting
In the Custom Charts app Admin Settings, click the Performance Options tab
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” textbox 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. |
FAQs
How do I know the rate limit has been reached? | Why would I enable rate limiting? |
|---|---|
You will see the error message below when trying to load a Custom Charts on a Dashboard.  | |