Skip to content

Add rate limit to CCAPI doc #20356

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 18, 2025
Merged

Add rate limit to CCAPI doc #20356

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e46d11
Add rate limit to CCAPI doc
jhlodin Sep 15, 2025
7c11132
Add detail about response to rate-limited request
jhlodin Sep 18, 2025
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
4 changes: 4 additions & 0 deletions src/current/cockroachcloud/cloud-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ To manage clusters and other resources in CockroachDB Cloud, you can also use th
If you used the API to manage CockroachDB Serverless clusters that have been migrated to CockroachDB Basic, ensure your code is updated to work with CockroachDB Basic.
{{site.data.alerts.end}}

{{site.data.alerts.callout_info}}
The Cloud API is rate-limited to 10 requests per second per user. When a request exceeds this limit, it receives an HTTP response with the `Retry-After` header and a "rate limit exceeded" message.
Copy link

@fantapop fantapop Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would also be nice to mention the response code. It should be an http 429. https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/429

Copy link
Contributor Author

@jhlodin jhlodin Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like the code used may be inconsistent as a bug, opting to keep generic for now

{{site.data.alerts.end}}

## Call the API

The API uses [bearer token authentication](https://swagger.io/docs/specification/authentication/bearer-authentication/), and each request requires a [secret key]({% link cockroachcloud/managing-access.md %}#api-access). The secret key is associated with a service account, and inherits the [permissions of the account]({% link cockroachcloud/managing-access.md %}#manage-service-accounts).
Expand Down
Loading