Skip to content

CockroachDB Cloud ​

Manage CockroachDB Cloud clusters, databases, SQL users, and networking.

DetailValue
CategoryDatabase
Base URLhttps://cockroachlabs.cloud/api/v1
AuthenticationBearer Token
Endpoints8
Connector keycockroachdb

Using CockroachDB Cloud in a workflow ​

  1. Go to Connections and click New Connection.
  2. Pick CockroachDB Cloud from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown — see the table below.

Available Endpoints ​

EndpointSummary
GET /clustersList clusters
POST /clustersCreate a cluster
GET /clusters/{cluster_id}Get cluster details
DELETE /clusters/{cluster_id}Delete a cluster
GET /clusters/{cluster_id}/databasesList databases
GET /clusters/{cluster_id}/sql-usersList SQL users
POST /clusters/{cluster_id}/sql-usersCreate a SQL user
GET /clusters/{cluster_id}/nodesList cluster nodes

Each endpoint has its own page with parameter details, an example API Call node configuration, and the response shape.