Cockroach Labs

Cockroach Labs integration (Developer Tools, Data). Imported from open-connector.

API key7 toolshttps://cockroachlabs.cloud

GET

cockroach_labs_get_organization

Get information about the caller's CockroachDB Cloud organization.

/api/v1/organization

GET

cockroach_labs_list_clusters

List CockroachDB Cloud clusters in the organization.

/api/v1/clusters

6 parameters

Param	Type	Required	Description
showInactive	boolean	optional	Whether to include deleted or failed clusters when allowed.
sortBy	string	optional	Field used to sort clusters.
page	string	optional	Opaque pagination page token returned by CockroachDB Cloud.
limit	integer	optional	Maximum number of records to return.
asOfTime	string	optional	Read data as of this RFC 3339 timestamp when supported.
sortOrder	string	optional	Pagination sort order.

GET

cockroach_labs_get_cluster

Get extended information about a CockroachDB Cloud cluster.

/api/v1/clusters/{clusterId}

1 parameter

Param	Type	Required	Description
clusterId	string	required	CockroachDB Cloud cluster ID.

GET

cockroach_labs_list_available_regions

List cloud regions available for new CockroachDB Cloud clusters and nodes.

/api/v1/clusters/available-regions

6 parameters

Param	Type	Required	Description
provider	string	optional	Cloud provider to filter by.
serverless	boolean	optional	Whether to only show regions available for serverless clusters.
page	string	optional	Opaque pagination page token returned by CockroachDB Cloud.
limit	integer	optional	Maximum number of records to return.
asOfTime	string	optional	Read data as of this RFC 3339 timestamp when supported.
sortOrder	string	optional	Pagination sort order.

GET

cockroach_labs_list_cluster_nodes

List nodes for a CockroachDB Cloud cluster.

/api/v1/clusters/{clusterId}/nodes

6 parameters

Param	Type	Required	Description
clusterId	string	required	CockroachDB Cloud cluster ID.
regionName	string	optional	Optional region name used to filter cluster nodes.
page	string	optional	Opaque pagination page token returned by CockroachDB Cloud.
limit	integer	optional	Maximum number of records to return.
asOfTime	string	optional	Read data as of this RFC 3339 timestamp when supported.
sortOrder	string	optional	Pagination sort order.

GET

cockroach_labs_list_databases

List databases for a CockroachDB Cloud cluster.

/api/v1/clusters/{clusterId}/databases

5 parameters

Param	Type	Required	Description
clusterId	string	required	CockroachDB Cloud cluster ID.
page	string	optional	Opaque pagination page token returned by CockroachDB Cloud.
limit	integer	optional	Maximum number of records to return.
asOfTime	string	optional	Read data as of this RFC 3339 timestamp when supported.
sortOrder	string	optional	Pagination sort order.

GET

cockroach_labs_list_sql_users

List SQL users for a CockroachDB Cloud cluster.

/api/v1/clusters/{clusterId}/sql-users

5 parameters

Param	Type	Required	Description
clusterId	string	required	CockroachDB Cloud cluster ID.
page	string	optional	Opaque pagination page token returned by CockroachDB Cloud.
limit	integer	optional	Maximum number of records to return.
asOfTime	string	optional	Read data as of this RFC 3339 timestamp when supported.
sortOrder	string	optional	Pagination sort order.