Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

patch: Updated API docs regarding rate limiting #3131

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions pages/reference/api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,20 @@ curl -X GET \
-H "Authorization: Bearer <AUTH_TOKEN>"
```

## Rate limiting
rhampt marked this conversation as resolved.
Show resolved Hide resolved

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.

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 automations rarely encounter issues.
rhampt marked this conversation as resolved.
Show resolved Hide resolved

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.

To maintain the best experience, we also need the flexibility to adapt and evolve the rate-limiting algorithm as required. Publishing fixed limits could constrain our ability to make improvements or respond to specific needs without disrupting customers. Instead, we provide a clear and simple interface: the `Retry-After` header. If a request exceeds the current rate limit, the response will include this header with a value indicating how long to wait before retrying. This ensures you can adapt dynamically without needing to understand the underlying details of the rate-limiting mechanism.
rhampt marked this conversation as resolved.
Show resolved Hide resolved


[odata]:https://www.odata.org/
[odata-docs]:https://www.odata.org/getting-started/basic-tutorial/
[resources]:/reference/api/resources/fleet
[tokens]:/learn/accounts/account#session-tokens
[api-keys]:/learn/accounts/account#api-keys

Loading