Skip to content

Commit 560b7a6

Browse files
authored
Add rate limit to CCAPI doc (#20356)
* Add rate limit to CCAPI doc * Add detail about response to rate-limited request
1 parent b476318 commit 560b7a6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/current/cockroachcloud/cloud-api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ To manage clusters and other resources in CockroachDB Cloud, you can also use th
1616
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.
1717
{{site.data.alerts.end}}
1818

19+
{{site.data.alerts.callout_info}}
20+
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.
21+
{{site.data.alerts.end}}
22+
1923
## Call the API
2024

2125
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).

0 commit comments

Comments
 (0)