CockroachDB Cloud

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

Detail	Value
Category	Database
Base URL	https://cockroachlabs.cloud/api/v1
Authentication	Bearer Token
Endpoints	8
Connector key	cockroachdb

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. The full list is below.

Available endpoints

Endpoint	Summary
GET /clusters	List clusters
POST /clusters	Create a cluster
GET /clusters/{cluster_id}	Get cluster details
DELETE /clusters/{cluster_id}	Delete a cluster
GET /clusters/{cluster_id}/databases	List databases
GET /clusters/{cluster_id}/sql-users	List SQL users
POST /clusters/{cluster_id}/sql-users	Create a SQL user
GET /clusters/{cluster_id}/nodes	List cluster nodes

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /clusters

List clusters

Detail	Value
Operation ID	database.listClusters
Method	GET
Path	/clusters

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CockroachDB Cloud connection from the Connection dropdown.
3. In the Operation dropdown, select database.listClusters.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CockroachDB Cloud API reference.

POST /clusters

Create a cluster

Detail	Value
Operation ID	database.createCluster
Method	POST
Path	/clusters

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CockroachDB Cloud connection from the Connection dropdown.
3. In the Operation dropdown, select database.createCluster.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CockroachDB Cloud API reference.

GET /clusters/{cluster_id}

Get cluster details

Detail	Value
Operation ID	database.getCluster
Method	GET
Path	/clusters/{cluster_id}

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CockroachDB Cloud connection from the Connection dropdown.
3. In the Operation dropdown, select database.getCluster.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CockroachDB Cloud API reference.

DELETE /clusters/{cluster_id}

Delete a cluster

Detail	Value
Operation ID	database.deleteCluster
Method	DELETE
Path	/clusters/{cluster_id}

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CockroachDB Cloud connection from the Connection dropdown.
3. In the Operation dropdown, select database.deleteCluster.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CockroachDB Cloud API reference.

GET /clusters/{cluster_id}/databases

List databases

Detail	Value
Operation ID	database.listDatabases
Method	GET
Path	/clusters/{cluster_id}/databases

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CockroachDB Cloud connection from the Connection dropdown.
3. In the Operation dropdown, select database.listDatabases.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CockroachDB Cloud API reference.

GET /clusters/{cluster_id}/sql-users

List SQL users

Detail	Value
Operation ID	database.listSQLUsers
Method	GET
Path	/clusters/{cluster_id}/sql-users

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CockroachDB Cloud connection from the Connection dropdown.
3. In the Operation dropdown, select database.listSQLUsers.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CockroachDB Cloud API reference.

POST /clusters/{cluster_id}/sql-users

Create a SQL user

Detail	Value
Operation ID	database.createSQLUser
Method	POST
Path	/clusters/{cluster_id}/sql-users

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CockroachDB Cloud connection from the Connection dropdown.
3. In the Operation dropdown, select database.createSQLUser.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CockroachDB Cloud API reference.

GET /clusters/{cluster_id}/nodes

List cluster nodes

Detail	Value
Operation ID	database.listNodes
Method	GET
Path	/clusters/{cluster_id}/nodes

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CockroachDB Cloud connection from the Connection dropdown.
3. In the Operation dropdown, select database.listNodes.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CockroachDB Cloud API reference.