Skip to content

Commit 5f2fa00

Browse files
rhamptvipulgupta2048
authored andcommitted
patch: Add rate limits to API docs
Added a section on rate limiting to our API docs so that customers can understand why we don't publish our rate limits.
1 parent 9f5972e commit 5f2fa00

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

pages/reference/api/overview.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,22 @@ curl -X GET \
129129
-H "Authorization: Bearer <AUTH_TOKEN>"
130130
```
131131

132+
## Rate limits
133+
134+
We intentionally do not publish detailed rate limits or the inner workings of our rate-limiting algorithm. Our goal is to keep the API experience as seamless as possible.
135+
136+
Engineers using our API shouldn’t have to manage the complexity of rate limits to automate workflows effectively. The rate limits we enforce are generous, and customers running large-scale automation rarely encounter issues.
137+
138+
Publishing specific rate limits often results in them being treated as a "target" or a fixed barrier, which is not how we intend the API to be used. Our rate limits are designed to provide a minimum level of protection for the API and to ensure consistent performance for all users, without requiring customers to worry about exceeding them.
139+
140+
To maintain the best experience, we also need the flexibility to adapt and evolve the rate-limiting algorithm. Publishing fixed limits could constrain our ability to improve and respond to specific needs without disrupting customers.
141+
142+
Instead, we provide the `Retry-After` header. The HTTP `Retry-After` response header indicates how long the user agent should wait before making a follow-up request. When a request exceeds the current rate limit, the response will include this header with a value indicating how long you should be waiting before retrying. This ensures your code can dynamically adapt on runtime without needing workarounds or context about the rate-limiting mechanism.
143+
144+
132145
[odata]:https://www.odata.org/
133146
[odata-docs]:https://www.odata.org/getting-started/basic-tutorial/
134147
[resources]:/reference/api/resources/fleet
135148
[tokens]:/learn/accounts/account#session-tokens
136149
[api-keys]:/learn/accounts/account#api-keys
150+

0 commit comments

Comments
 (0)