# CockroachDB: Cloud Deployments Cloud API Reference ## Cloud API Reference - [Cloud Deployments / Cloud API Reference / 2026-09-15 (Latest) (162 pages)](https://docs.cockroachlabs.com/_llms/cloud-deployments/cloud-api-reference/2026-09-15-latest.md): Documentation for Cloud Deployments / Cloud API Reference / 2026-09-15 (Latest). - [Cloud Deployments / Cloud API Reference / 2024-09-16 (151 pages)](https://docs.cockroachlabs.com/_llms/cloud-deployments/cloud-api-reference/2024-09-16.md): Documentation for Cloud Deployments / Cloud API Reference / 2024-09-16. - [Cloud Deployments / Cloud API Reference / 2023-04-10 (125 pages)](https://docs.cockroachlabs.com/_llms/cloud-deployments/cloud-api-reference/2023-04-10.md): Documentation for Cloud Deployments / Cloud API Reference / 2023-04-10. ### 2022-09-20 #### Overview - [CockroachDB Cloud API](https://docs.cockroachlabs.com/docs/api/cloud/2022-09-20.md) #### Endpoints ##### CockroachCloud - [List available major cluster versions](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-available-major-cluster-versions.md): Sort order: Version number descending - [List clusters owned by an organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-clusters-owned-by-an-organization.md): Sort order: Cluster name - [Create and initialize a new cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-and-initialize-a-new-cluster.md) - [List the regions available for new clusters and nodes](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-the-regions-available-for-new-clusters-and-nodes.md): Sort order: Distance (based on client IP address) - [Get extended information about a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-extended-information-about-a-cluster.md) - [Delete a cluster and all of its data](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-a-cluster-and-all-of-its-data.md) - [Scale or edit a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/scale-or-edit-a-cluster.md) - [Get Client CA Cert information for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-client-ca-cert-information-for-a-cluster.md) - [Set Client CA Cert for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/set-client-ca-cert-for-a-cluster.md) - [Delete Client CA Cert for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-client-ca-cert-for-a-cluster.md) - [Update Client CA Cert for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-client-ca-cert-for-a-cluster.md) - [Get CMEK-related information for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-cmek-related-information-for-a-cluster.md) - [Enable or update the CMEK spec for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/enable-or-update-the-cmek-spec-for-a-cluster.md) - [Enable CMEK for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/enable-cmek-for-a-cluster.md) - [Update the CMEK-related status for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-the-cmek-related-status-for-a-cluster.md) - [Get a formatted generic connection string for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-a-formatted-generic-connection-string-for-a-cluster.md) - [List databases for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-databases-for-a-cluster.md): Sort order: Database name ascending - [Create a new database](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-a-new-database.md) - [Update a database](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-a-database.md) - [Delete a database](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-a-database.md) - [Update a database](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-a-database-1.md) - [Get the Log Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-the-log-export-configuration-for-a-cluster.md) - [Create or update the Log Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-or-update-the-log-export-configuration-for-a-cluster.md) - [Delete the Log Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-the-log-export-configuration-for-a-cluster.md) - [Get the CloudWatch Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-the-cloudwatch-metric-export-configuration-for-a-cluster.md) - [Create or update the CloudWatch Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-or-update-the-cloudwatch-metric-export-configuration-for-a-cluster.md) - [Delete the CloudWatch Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-the-cloudwatch-metric-export-configuration-for-a-cluster.md) - [Get the Datadog Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-the-datadog-metric-export-configuration-for-a-cluster.md) - [Create or update the Datadog Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-or-update-the-datadog-metric-export-configuration-for-a-cluster.md) - [Delete the Datadog Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-the-datadog-metric-export-configuration-for-a-cluster.md) - [Get the IP allowlist and propagation status for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-the-ip-allowlist-and-propagation-status-for-a-cluster.md): Sort order: CIDR address - [Add a new CIDR address to the IP allowlist](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/add-a-new-cidr-address-to-the-ip-allowlist.md) - [Delete an IP allowlist entry](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-an-ip-allowlist-entry.md) - [Add a new CIDR address to the IP allowlist](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/add-a-new-cidr-address-to-the-ip-allowlist-1.md) - [Update an IP allowlist entry](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-an-ip-allowlist-entry.md) - [Lists all AwsEndpointConnections for a given cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/lists-all-awsendpointconnections-for-a-given-cluster.md) - [Sets the AWS Endpoint Connection state based on what is passed in the body](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/sets-the-aws-endpoint-connection-state-based-on-what-is-passed-in-the-body.md): The "status" in the returned proto does not reflect the latest post-update status, but rather the status before the state is transitioned. - [List all egress rules associates with a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-all-egress-rules-associates-with-a-cluster.md): Sort order: Name - [Add an egress rule](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/add-an-egress-rule.md) - [Outbound traffic management](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/outbound-traffic-management.md) - [Get an existing egress rule](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-an-existing-egress-rule.md) - [Delete an existing egress rule](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-an-existing-egress-rule.md) - [Edit an existing egress rule](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/edit-an-existing-egress-rule.md) - [Lists all PrivateEndpointServices for a given cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/lists-all-privateendpointservices-for-a-given-cluster.md): The internal_dns property from the regions field in the ListClusters response can be used to connect to PrivateEndpointServices. - [Creates all PrivateEndpointServices for a given cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/creates-all-privateendpointservices-for-a-given-cluster.md) - [List nodes for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-nodes-for-a-cluster.md): Sort order: Region name, node name - [List SQL users for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-sql-users-for-a-cluster.md): Sort order: Username - [Create a new SQL user](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-a-new-sql-user.md) - [Delete a SQL user](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-a-sql-user.md) - [Update a SQL user's password](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-a-sql-users-password.md) - [List invoices for a given organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-invoices-for-a-given-organization.md): Sort order: invoice start date ascending - [Gets a specific invoice for an organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/gets-a-specific-invoice-for-an-organization.md) - [Get information about the caller's organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-information-about-the-callers-organization.md) - [Lists all RoleGrants](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/lists-all-rolegrants.md) - [Gets All Role Grants for the specified user](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/gets-all-role-grants-for-the-specified-user.md) - [Makes the users roles exactly those provided](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/makes-the-users-roles-exactly-those-provided.md) - [Adds the user to the given role](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/adds-the-user-to-the-given-role.md) - [Removes the user from the given role](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-09-20/cockroachcloud/removes-the-user-from-the-given-role.md) ### 2022-03-31 #### Overview - [CockroachDB Cloud API](https://docs.cockroachlabs.com/docs/api/cloud/2022-03-31.md) #### Endpoints ##### CockroachCloud - [List clusters owned by an organization.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/list-clusters-owned-by-an-organization.md): Sort order: Cluster name - [Create and initialize a new cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/create-and-initialize-a-new-cluster.md) - [List the regions available for new clusters and nodes.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/list-the-regions-available-for-new-clusters-and-nodes.md): Sort order: Distance (based on client IP address) - [Get extended information about a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/get-extended-information-about-a-cluster.md) - [Delete a cluster and all of its data.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/delete-a-cluster-and-all-of-its-data.md) - [Scale or edit a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/scale-or-edit-a-cluster.md) - [Get CMEK-related information for a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/get-cmek-related-information-for-a-cluster.md) - [Enable CMEK for a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/enable-cmek-for-a-cluster.md) - [Update the CMEK-related status for a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/update-the-cmek-related-status-for-a-cluster.md) - [Get the IP allowlist and propagation status for a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/get-the-ip-allowlist-and-propagation-status-for-a-cluster.md): Sort order: CIDR address - [Add a new CIDR address to the IP allowlist.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/add-a-new-cidr-address-to-the-ip-allowlist.md) - [Delete an IP allowlist entry.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/delete-an-ip-allowlist-entry.md) - [Add a new CIDR address to the IP allowlist.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/add-a-new-cidr-address-to-the-ip-allowlist-1.md) - [Update an IP allowlist entry.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/update-an-ip-allowlist-entry.md) - [List nodes for a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/list-nodes-for-a-cluster.md): Sort order: Region name, node name - [List SQL users for a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/list-sql-users-for-a-cluster.md): Sort order: Username - [Create a new SQL user.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/create-a-new-sql-user.md) - [Delete a SQL user.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/delete-a-sql-user.md) - [Update a SQL user's password.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2022-03-31/cockroachcloud/update-a-sql-users-password.md) ## OpenAPI Specs - [2024-09-16](/openapi/cloud/2024-09-16.json) - [latest](/openapi/cloud/latest.json) - [2023-04-10](/openapi/cloud/2023-04-10.json) - [2022-09-20](/openapi/cloud/2022-09-20.json) - [2022-03-31](/openapi/cloud/2022-03-31.json)