CockroachDB Cloud API
An API for managing CockroachDB Cloud resources
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
An API for managing CockroachDB Cloud resources
Endpoints 165
SCIM
- GETList groups
/api/scim/v2/GroupsCan be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - POSTCreate a group
/api/scim/v2/GroupsCan be used by the following roles assigned at the organization scope: ORG_ADMIN - PUTSearch groups (Deprecated)
/api/scim/v2/Groups/.searchDeprecated. Can be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - POSTSearch groups
/api/scim/v2/Groups/.searchSimilar to GetGroups however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details.… - GETGet a group by ID
/api/scim/v2/Groups/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - PUTUpdate a group by supplying all values of the user object
/api/scim/v2/Groups/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN - DELETEDelete a group based on ID
/api/scim/v2/Groups/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN - PATCHPatch a group by supplying partial updates
/api/scim/v2/Groups/:idApply a sequence of operations to modify attributes of a SCIM Group resource. Supports 'add', 'remove', and 'replace' operations per RFC 7644 Section 3.5.2.… - PUTSearch a group by ID (Deprecated)
/api/scim/v2/Groups/:id/.searchDeprecated. Can be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - POSTSearch a group by ID
/api/scim/v2/Groups/:id/.searchSimilar to GetGroup however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details.… - GETList the SCIM resource types
/api/scim/v2/ResourceTypesThis endpoint may be used by any member of the organization. - GETGet a SCIM resource type by ID
/api/scim/v2/ResourceTypes/:resourceIdThis endpoint may be used by any member of the organization. - GETList the SCIM schemas
/api/scim/v2/SchemasThis endpoint may be used by any member of the organization. - GETGet a SCIM schema by ID
/api/scim/v2/Schemas/:schemaIdThis endpoint may be used by any member of the organization. - GETReturn the SCIM Service Provider configuration
/api/scim/v2/ServiceProviderConfigThis endpoint may be used by any member of the organization. - GETList Users
/api/scim/v2/UsersCan be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - POSTCreate a user
/api/scim/v2/UsersCan be used by the following roles assigned at the organization scope: ORG_ADMIN - PUTSearch User (Deprecated)
/api/scim/v2/Users/.searchDeprecated. Can be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - POSTSearch Users
/api/scim/v2/Users/.searchSimilar to GetUsers however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details.… - GETGet a user by ID
/api/scim/v2/Users/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - PUTUpdate a user by supplying all values of the user object
/api/scim/v2/Users/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN - DELETEDelete a user based on ID
/api/scim/v2/Users/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN - PATCHPatch a user by supplying partial updates
/api/scim/v2/Users/:idApply a sequence of operations to modify attributes of a SCIM User resource. Supports 'add', 'remove', and 'replace' operations per RFC 7644 Section 3.5.2.… - PUTSearch for a user by ID (Deprecated)
/api/scim/v2/Users/:id/.searchDeprecated. Can be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - POSTSearch for a user by ID
/api/scim/v2/Users/:id/.searchSimilar to GetUser however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details. Can…
Organizations
- GETGet information about the caller's organization
/api/v1/organizationCan be used by the following roles assigned at the organization scope: ORG_ADMIN ORG_MEMBER AUDITOR
Clusters
- GETList available major cluster versions
/api/v1/cluster-versionsSort order: Version number descending This endpoint may be used by any member of the organization. - GETList clusters in the organization
/api/v1/clustersBy default, clusters are sorted alphabetically by name in ascending A to Z order. To customize sorting, use the pagination.sort_by and pagination.sort_order… - POSTCreate and initialize a new cluster
/api/v1/clustersCan be used by the following roles assigned at the organization or folder scope: CLUSTER_ADMIN CLUSTER_CREATOR - GETList the regions available for new clusters and nodes
/api/v1/clusters/available-regionsSort order: Distance (based on client IP address) This endpoint may be used by any member of the organization. - GETGet extended information about a cluster
/api/v1/clusters/:cluster_idCan be used by the following roles assigned at the organization, folder or cluster scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER… - DELETEDelete a cluster and all of its data
/api/v1/clusters/:cluster_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN - PATCHScale, edit or upgrade a cluster
/api/v1/clusters/:cluster_idIn addition to adding nodes and changing cluster fields, the PATCH Cluster endpoint can be used to upgrade the cluster version. A cluster can be upgraded when… - GETGet a formatted generic connection string for a cluster
/api/v1/clusters/:cluster_id/connection-stringCan be used by the following roles assigned at the organization, folder or cluster scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER… - GETList nodes for a cluster
/api/v1/clusters/:cluster_id/nodesSort order: Region name, node name Can be used by the following roles assigned at the organization, folder or cluster scope: ORG_ADMIN CLUSTER_ADMIN… - POSTCreate a virtual cluster in a workspace
/api/v1/virtual-cluster-workspaces/:workspace_id/clustersCan be used by the following roles assigned at the organization or folder scope: CLUSTER_ADMIN CLUSTER_CREATOR Setting a custom virtual_cpu_burst_limit for… - PATCHUpdate a specific virtual cluster
/api/v1/virtual-cluster-workspaces/:workspace_id/clusters/:cluster_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER Setting a custom…
Cluster Disruption
- GETGet disruption specifications for a cluster
/api/v1/clusters/:cluster_id/disruptCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - PUTUpdate disruption specifications for a cluster
/api/v1/clusters/:cluster_id/disruptCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
SQL Users
- GETList SQL users for a cluster
/api/v1/clusters/:cluster_id/sql-usersSort order: Username Can be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER… - POSTCreate a new SQL user
/api/v1/clusters/:cluster_id/sql-usersCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN - DELETEDelete a SQL user
/api/v1/clusters/:cluster_id/sql-users/:nameCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN - PUTUpdate a SQL user's password
/api/v1/clusters/:cluster_id/sql-users/:name/passwordCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN
Migration Assistant
- GETGet the Migration Assistant for a cluster.
/api/v1/clusters/:cluster_id/migration-assistantIncludes the lifecycle status and, while RUNNING, the URL and sign-in credentials for the assistant; treat the response as sensitive. Can be used by the… - POSTProvision a Migration Assistant for a cluster.
/api/v1/clusters/:cluster_id/migration-assistantThe assistant is a per-cluster, dedicated-cluster-only migration tool. Poll GetMigrationAssistant until its status is RUNNING to retrieve the URL and… - DELETEDelete the Migration Assistant for a cluster.
/api/v1/clusters/:cluster_id/migration-assistantTears down the deployment and returns the assistant in its DELETING status. Can be used by the following roles assigned at the organization, folder or cluster… - GETGet the source-database CA certificate for a cluster's Migration Assistant.
/api/v1/clusters/:cluster_id/migration-assistant/source-ca-certReturns the custom CA certificate bundle the assistant trusts when connecting to its source database. Returns an empty bundle when the assistant uses the… - DELETEDelete the source-database CA certificate for a cluster's Migration Assistant.
/api/v1/clusters/:cluster_id/migration-assistant/source-ca-certReverts the assistant to the system trust roots and returns the deleted certificate bundle. Can be used by the following roles assigned at the organization,… - PATCHUpdate the source-database CA certificate for a cluster's Migration Assistant.
/api/v1/clusters/:cluster_id/migration-assistant/source-ca-certReplaces the custom CA certificate bundle the assistant trusts when connecting to its source database. Returns the updated certificate bundle. Can be used by…
Databases
- GETList databases for a cluster
/api/v1/clusters/:cluster_id/databasesSort order: Database name ascending Can be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN… - POSTCreate a new database
/api/v1/clusters/:cluster_id/databasesCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DATA_ACCESSOR - PATCHUpdate a database
/api/v1/clusters/:cluster_id/databasesCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DATA_ACCESSOR - DELETEDelete a database
/api/v1/clusters/:cluster_id/databases/:nameCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DATA_ACCESSOR - PATCHUpdate a database
/api/v1/clusters/:cluster_id/databases/:nameCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DATA_ACCESSOR
Customer-managed Encryption Keys
- GETGet CMEK-related information for a cluster
/api/v1/clusters/:cluster_id/cmekCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - PUTEnable or update the CMEK spec for a cluster
/api/v1/clusters/:cluster_id/cmekCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - POSTEnable CMEK for a cluster
/api/v1/clusters/:cluster_id/cmekCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - PATCHUpdate the CMEK-related status for a cluster
/api/v1/clusters/:cluster_id/cmekCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Client CA Certificates
- GETGet Client CA Cert information for a cluster
/api/v1/clusters/:cluster_id/client-ca-certCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - POSTSet Client CA Cert for a cluster
/api/v1/clusters/:cluster_id/client-ca-certCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - DELETEDelete Client CA Cert for a cluster
/api/v1/clusters/:cluster_id/client-ca-certCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - PATCHUpdate Client CA Cert for a cluster
/api/v1/clusters/:cluster_id/client-ca-certCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Log Export
- GETGet the Log Export configuration for a cluster
/api/v1/clusters/:cluster_id/logexportCan be used by the following roles assigned at the organization, folder or cluster scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER METRICS_VIEWER AUDITOR - POSTCreate or update the Log Export configuration for a cluster
/api/v1/clusters/:cluster_id/logexportCan be used by the following roles assigned at the organization, folder or cluster scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - DELETEDelete the Log Export configuration for a cluster
/api/v1/clusters/:cluster_id/logexportCan be used by the following roles assigned at the organization, folder or cluster scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Metric Export
- GETGet the CloudWatch Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/cloudwatchCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER METRICS_VIEWER AUDITOR - POSTCreate or update the CloudWatch Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/cloudwatchCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - DELETEDelete the CloudWatch Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/cloudwatchCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - GETGet the Datadog Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/datadogCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER METRICS_VIEWER AUDITOR - POSTCreate or update the Datadog Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/datadogCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - DELETEDelete the Datadog Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/datadogCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - GETGet the OTLP Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/otlpCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER METRICS_VIEWER AUDITOR - POSTCreate or update the OTLP Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/otlpCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - DELETEDelete the OTLP Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/otlpCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - GETGet the Prometheus Metric Export configuration for a cluster
/api/v1/clusters/:cluster_id/metricexport/prometheusCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER METRICS_VIEWER AUDITOR - POSTEnable Prometheus Metric Export for a cluster
/api/v1/clusters/:cluster_id/metricexport/prometheusCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - DELETEDisable Prometheus Metric Export for a cluster
/api/v1/clusters/:cluster_id/metricexport/prometheusCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Audit Logs
- GETList audit logs
/api/v1/auditlogeventsCan be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR
IP Allowlists
- GETGet the IP allowlist and propagation status for a cluster
/api/v1/clusters/:cluster_id/networking/allowlistNot available on host clusters; the allowlist is managed on the virtual clusters running on the host. Sort order: CIDR address Can be used by the following… - POSTAdd a new CIDR address to the IP allowlist
/api/v1/clusters/:cluster_id/networking/allowlistNot available on host clusters; the allowlist is managed on the virtual clusters running on the host. Can be used by the following roles assigned at the… - PUTAdd a new CIDR address to the IP allowlist
/api/v1/clusters/:cluster_id/networking/allowlist/:cidr_ip/:cidr_maskNot available on host clusters; the allowlist is managed on the virtual clusters running on the host. Can be used by the following roles assigned at the… - DELETEDelete an IP allowlist entry
/api/v1/clusters/:cluster_id/networking/allowlist/:cidr_ip/:cidr_maskNot available on host clusters; the allowlist is managed on the virtual clusters running on the host. Can be used by the following roles assigned at the… - PATCHUpdate an IP allowlist entry
/api/v1/clusters/:cluster_id/networking/allowlist/:cidr_ip/:cidr_maskNot available on host clusters; the allowlist is managed on the virtual clusters running on the host. Can be used by the following roles assigned at the…
Egress Rules
- GETList all egress rules associated with a cluster
/api/v1/clusters/:cluster_id/networking/egress-rulesSort order: Name Can be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - POSTAdd an egress rule
/api/v1/clusters/:cluster_id/networking/egress-rulesCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - POSTOutbound traffic management
/api/v1/clusters/:cluster_id/networking/egress-rules/egress-traffic-policyCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - GETGet an existing egress rule
/api/v1/clusters/:cluster_id/networking/egress-rules/:rule_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - DELETEDelete an existing egress rule
/api/v1/clusters/:cluster_id/networking/egress-rules/:rule_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - PATCHEdit an existing egress rule
/api/v1/clusters/:cluster_id/networking/egress-rules/:rule_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Billing
- GETList invoices for a given organization
/api/v1/invoicesSort order: invoice start date ascending Can be used by the following roles assigned at the organization scope: BILLING_COORDINATOR CLUSTER_ADMIN - GETGet a specific invoice for an organization
/api/v1/invoices/:invoice_idCan be used by the following roles assigned at the organization scope: BILLING_COORDINATOR CLUSTER_ADMIN - GETList an invoice's daily usage breakdown
/api/v1/invoices/:invoice_id/daily-usageReturns daily usage line items for an invoice. Each row is a distinct charge for a cluster on a given day, so a cluster may have several rows per day.…
Maintenance Windows
- GETGet the maintenance window for a cluster
/api/v1/clusters/:cluster_id/maintenance-windowCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER AUDITOR - PUTSet the maintenance window for a cluster
/api/v1/clusters/:cluster_id/maintenance-windowMaintenance windows are supported for ADVANCED clusters. Can be used by the following roles assigned at the organization, folder or cluster scope:… - DELETEDelete the maintenance window for a cluster
/api/v1/clusters/:cluster_id/maintenance-windowCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Blackout Windows
- GETList all blackout windows for a cluster
/api/v1/clusters/:cluster_id/blackout-windowsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - POSTCreate a blackout window for a cluster
/api/v1/clusters/:cluster_id/blackout-windowsBlackout windows are supported for ADVANCED clusters only. Can be used by the following roles assigned at the organization, folder or cluster scope:… - GETGet a blackout window by its ID for a cluster
/api/v1/clusters/:cluster_id/blackout-windows/:blackout_window_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - DELETEDelete a blackout window for a cluster
/api/v1/clusters/:cluster_id/blackout-windows/:blackout_window_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - PATCHUpdate a blackout window for a cluster
/api/v1/clusters/:cluster_id/blackout-windows/:blackout_window_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Role Management
- GETList all RoleGrants
/api/v1/rolesCan be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN FOLDER_ADMIN AUDITOR - GETGet all role grants for a user, service account, or group
/api/v1/roles/:user_idGet all role grants for a user, service account, or group by providing its ID in the user_id path parameter. Can be used by the following roles assigned at… - PUTReplace the roles for a user, service account, or group with exactly those provided
/api/v1/roles/:user_idReplace the entire role set for a user, service account, or group by providing its ID in the user_id path parameter. Roles that will be removed or added as a… - POSTAdd a role to a user, service account, or group
/api/v1/roles/:user_id/:resource_type/:resource_id/:role_nameAdd a single role to a user, service account, or group by providing its ID in the user_id path parameter. Roles that will be added as a result of this call… - DELETERemove a role from a user, service account, or group
/api/v1/roles/:user_id/:resource_type/:resource_id/:role_nameRemove a single role from a user, service account, or group by providing its ID in the user_id path parameter. A principal's last remaining role cannot be… - GETSearch person users by email address
/api/v1/users/persons-by-email?email=stringCan be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN FOLDER_ADMIN AUDITOR
Service Accounts
- GETList service accounts for an organization
/api/v1/service-accountsSort order: Service account name Can be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN AUDITOR - POSTCreate a service account
/api/v1/service-accountsCan be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN - GETGet a service account by ID
/api/v1/service-accounts/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN AUDITOR - DELETEDelete a service account
/api/v1/service-accounts/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN - PATCHUpdate a service account
/api/v1/service-accounts/:idTo manage roles associated with a service account after creation, pass the service_account_id instead of a user_id to any Role Management endpoint. Can be… - GETList a service account's OAuth credentials
/api/v1/service-accounts/:service_account_id/credentialsSort order: created_at Can be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN AUDITOR - POSTCreate an OAuth credential for a service account
/api/v1/service-accounts/:service_account_id/credentialsCan be used by the following roles assigned at the organization scope: ORG_ADMIN - DELETEDelete a service account's OAuth credential
/api/v1/service-accounts/:service_account_id/credentials/:credential_idCan be used by the following roles assigned at the organization scope: ORG_ADMIN
API Keys
- GETList API Keys
/api/v1/api-keysSort order: created_at Can be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN AUDITOR - POSTCreate a new API Key
/api/v1/api-keysCan be used by the following roles assigned at the organization scope: ORG_ADMIN - GETGet an API Key by ID
/api/v1/api-keys/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN AUDITOR - DELETEDelete an API Key
/api/v1/api-keys/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN - PATCHUpdate an API Key
/api/v1/api-keys/:idCan be used by the following roles assigned at the organization scope: ORG_ADMIN
Folders
- GETList folders owned by an organization
/api/v1/foldersSort order: Folder name Can be used by the following roles assigned at the organization or folder scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER… - POSTCreate a folder
/api/v1/foldersCan be used by the following roles assigned at the organization or folder scope: FOLDER_ADMIN - GETGet folder info for a folder
/api/v1/folders/:folder_idCan be used by the following roles assigned at the organization or folder scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER… - DELETEDelete a folder
/api/v1/folders/:folder_idCan be used by the following roles assigned at the organization or folder scope: FOLDER_ADMIN - PATCHUpdate a folder
/api/v1/folders/:folder_idCan be used by the following roles assigned at the organization or folder scope: FOLDER_ADMIN FOLDER_MOVER - GETList contents of a folder
/api/v1/folders/:folder_id/contentsSet folder_id to 'root' to list root level contents. Sort order: Folders sorted by name, followed by Clusters sorted by name. Can be used by the following…
Version Deferral
- GETGet the version upgrade deferral policy for a cluster.
/api/v1/clusters/:cluster_id/version-deferralCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER AUDITOR - PUTSet the version upgrade deferral policy for a cluster
/api/v1/clusters/:cluster_id/version-deferralCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
JWT Issuers
- GETList all JWT Issuers
/api/v1/jwt-issuersLists all the JWT Issuer configurations registered for the CockroachDB Cloud organization Can be used by the following roles assigned at the organization… - POSTAdd a JWT Issuer
/api/v1/jwt-issuersRegisters a JWT Issuer with the CockroachDB Cloud to allow verifying JWTs during API authentication Can be used by the following roles assigned at the… - GETGet a JWT Issuer
/api/v1/jwt-issuers/:idRetrieves the JWT Issuer configuration Can be used by the following roles assigned at the organization scope: ORG_ADMIN AUDITOR - DELETEDelete a JWT Issuer
/api/v1/jwt-issuers/:idDeletes the JWT Issuer configuration Can be used by the following roles assigned at the organization scope: ORG_ADMIN - PATCHUpdate a JWT Issuer
/api/v1/jwt-issuers/:idUpdates the JWT Issuer configuration Can be used by the following roles assigned at the organization scope: ORG_ADMIN
Private Endpoint Services
- GETList all AwsEndpointConnections for a cluster
/api/v1/clusters/:cluster_id/networking/aws-endpoint-connectionsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER AUDITOR - PATCHSet the AWS Endpoint Connection state
/api/v1/clusters/:cluster_id/networking/aws-endpoint-connections/:endpoint_idThe "status" in the response does not reflect the latest post-update status, but rather the status before the state is transitioned. Can be used by the… - GETList all connections to a cluster's private endpoint service.
/api/v1/clusters/:cluster_id/networking/private-endpoint-connectionsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER AUDITOR - POSTAdd a connection to a cluster's private endpoint service.
/api/v1/clusters/:cluster_id/networking/private-endpoint-connectionsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - DELETEDelete a connection from a cluster's private endpoint service.
/api/v1/clusters/:cluster_id/networking/private-endpoint-connections/:endpoint_idRemove a private endpoint from a service's trusted endpoints list. Caller should make sure to URL encode the endpoint_id before calling this method. Can be… - GETList all PrivateEndpointServices for a cluster
/api/v1/clusters/:cluster_id/networking/private-endpoint-servicesThe internal_dns property from the regions field in the ListClusters response can be used to connect to PrivateEndpointServices. Can be used by the following… - POSTCreate all PrivateEndpointServices for a cluster
/api/v1/clusters/:cluster_id/networking/private-endpoint-servicesCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - GETList all private endpoint trusted owners for a cluster
/api/v1/clusters/:cluster_id/networking/private-endpoint-trusted-ownersCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - POSTAdd a private endpoint trusted owner to a cluster
/api/v1/clusters/:cluster_id/networking/private-endpoint-trusted-ownersCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN - GETGet a private endpoint trusted owner entry for a cluster
/api/v1/clusters/:cluster_id/networking/private-endpoint-trusted-owners/:owner_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - DELETERemove a private endpoint trusted owner from a cluster
/api/v1/clusters/:cluster_id/networking/private-endpoint-trusted-owners/:owner_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN
Physical Cluster Replication
- GETList physical replication streams
/api/v1/physical-replication-streamsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER - POSTCreate a physical replication stream
/api/v1/physical-replication-streamsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN - GETGet a physical replication stream
/api/v1/physical-replication-streams/:idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER - PATCHUpdate a physical replication stream
/api/v1/physical-replication-streams/:idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN
Backup/Restore
- GETList cluster backups
/api/v1/clusters/:cluster_id/backupsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - GETGet the backup configuration for a cluster
/api/v1/clusters/:cluster_id/backups-configCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - PATCHUpdate the backup configuration for a cluster
/api/v1/clusters/:cluster_id/backups-configCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - GETList restore jobs
/api/v1/clusters/:cluster_id/restoresCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - GETView a restore job
/api/v1/clusters/:cluster_id/restores/:restore_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER AUDITOR - POSTCreate a restore
/api/v1/clusters/:destination_cluster_id/restoresCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Egress Private Endpoints
- GETList egress private endpoints
/api/v1/clusters/:cluster_id/networking/egress-private-endpointsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER AUDITOR - POSTCreate an egress private endpoint
/api/v1/clusters/:cluster_id/networking/egress-private-endpointsCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - GETGet egress private endpoint
/api/v1/clusters/:cluster_id/networking/egress-private-endpoints/:idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER AUDITOR - DELETEDelete an egress private endpoint
/api/v1/clusters/:cluster_id/networking/egress-private-endpoints/:idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - PATCHUpdate egress private endpoint.
/api/v1/clusters/:cluster_id/networking/egress-private-endpoints/:idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - PATCHUpdate egress private endpoint domain names. This endpoint is deprecated
in favor of PATCH /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}
and will be removed in a future version.
/api/v1/clusters/:cluster_id/networking/egress-private-endpoints/:id/domain-namesDeprecated. Can be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Runtime Scanning
- GETGet the runtime scanning status of a cluster.
/api/v1/clusters/:cluster_id/runtime-scanningCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER AUDITOR… - POSTEnable runtime scanning on a cluster.
/api/v1/clusters/:cluster_id/runtime-scanningCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER - DELETEDisable runtime scanning on a cluster.
/api/v1/clusters/:cluster_id/runtime-scanningCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER
Virtual Cluster Workspaces
- GETList workspaces in the organization
/api/v1/virtual-cluster-workspacesSort order: workspace name Can be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER… - GETShow details for a specific workspace
/api/v1/virtual-cluster-workspaces/:workspace_idCan be used by the following roles assigned at the organization scope: ORG_ADMIN CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER CLUSTER_DEVELOPER CLUSTER_CREATOR AUDITOR - PATCHUpdate the configuration of a specific workspace
/api/v1/virtual-cluster-workspaces/:workspace_idCan be used by the following roles assigned at the organization, folder or cluster scope: CLUSTER_ADMIN CLUSTER_OPERATOR_WRITER Changes to a workspace's…
API details
- Base URL
https://cockroachlabs.cloud- Authentication
- A bearer token in the Authorization header
- Operations
- 165 operations on 85 pathsGET 68POST 35DELETE 27PATCH 22PUT 13
5 marked deprecated - Main resources
- SCIM 25Metric Export 12Clusters 11Private Endpoint Services 11Service Accounts 8Backup/Restore 6Egress Private Endpoints 6Egress Rules 6Folders 6Migration Assistant 6
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2026-09-15 - Links
- Documentation · OpenAPI document · Support
- Listed from
- CockroachDB's published OpenAPI description (cockroachdb/cockroach-cloud-sdk-go) (Apache-2.0)
How to test the CockroachDB Cloud API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the CockroachDB Cloud API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List groups” (GET /api/scim/v2/Groups), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the CockroachDB Cloud API?
An API for managing CockroachDB Cloud resources It is listed under Data & analytics and has 165 endpoints.
Who publishes the CockroachDB Cloud API?
It is listed from CockroachDB's public API description (an OpenAPI document), not published by CockroachDB on Swastik Codes. Anyone who controls cockroachlabs.com can claim the profile by adding a DNS TXT record.
What is the base URL of the CockroachDB Cloud API?
Requests go to https://cockroachlabs.cloud. Endpoint paths are added to this base URL.
How do I authenticate with the CockroachDB Cloud API?
With A bearer token in the Authorization header.
How many endpoints does the CockroachDB Cloud API have?
165 operations on 85 paths (68 GET, 35 POST, 27 DELETE, 22 PATCH, 13 PUT). The largest groups are SCIM, Metric Export, Clusters, Private Endpoint Services.
Is forking the CockroachDB Cloud API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.