From 9e46d11141ea5ee893ad4670afa9c5f5d4112e8c Mon Sep 17 00:00:00 2001 From: Joe Lodin Date: Mon, 15 Sep 2025 15:29:41 -0400 Subject: [PATCH 1/2] Add rate limit to CCAPI doc --- src/current/cockroachcloud/cloud-api.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/current/cockroachcloud/cloud-api.md b/src/current/cockroachcloud/cloud-api.md index be9d98c5caf..eb59ae96a1c 100644 --- a/src/current/cockroachcloud/cloud-api.md +++ b/src/current/cockroachcloud/cloud-api.md @@ -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. +{{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). From 7c11132baa47940921ada52cdfdd37c2b346c2a0 Mon Sep 17 00:00:00 2001 From: Joe Lodin Date: Thu, 18 Sep 2025 15:49:51 -0400 Subject: [PATCH 2/2] Add detail about response to rate-limited request --- src/current/cockroachcloud/cloud-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/current/cockroachcloud/cloud-api.md b/src/current/cockroachcloud/cloud-api.md index eb59ae96a1c..48996427679 100644 --- a/src/current/cockroachcloud/cloud-api.md +++ b/src/current/cockroachcloud/cloud-api.md @@ -17,7 +17,7 @@ If you used the API to manage CockroachDB Serverless clusters that have been mig {{site.data.alerts.end}} {{site.data.alerts.callout_info}} -The Cloud API is rate-limited to 10 requests per second per user. +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. {{site.data.alerts.end}} ## Call the API