CockroachDB

Databases API access token

Manage CockroachDB Cloud clusters, users, allowlists and private endpoints from any Windmill script, flow or app.

Set up in 3 steps

Create an API key

In the CockroachDB Cloud console, open Access Management then Service Accounts. Create one with the roles your scripts need, then create an API key for it.

Add the resource in Windmill

Open Resources, add a resource of type cockroachdb, and paste the token.

Run your first script

Fork any script below and read before writing anything. There are hundreds here, so search by the verb you need.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Resource type

cockroachdb — the shape of the credential every script on this page expects.

View raw schema →

Field	Type	Required	What it is
token	string	Yes	Access token retrieved from the dashboard.

Questions

Is this for running SQL?

No. This manages the Cloud account — clusters, users, networking. To query a database, add a postgresql resource pointing at the cluster.

Creating clusters costs money

A cluster bills from the moment it exists. Scripts that create one should have a matching path that deletes it.

Is my token stored on the hub?

Never. It lives only in your own Windmill workspace, encrypted at rest.

Set up in 3 steps

Create an API key

Add the resource in Windmill

Run your first script

Scripts

Update the backup configuration for a cluster

Update the CMEK-related status for a cluster

Update disruption specifications for a cluster

Update an IP allowlist entry

Update an API Key

Update a user by supplying all values of the user object

Update a service account

Update a physical replication stream

Update a group by supplying all values of the user object

Update a folder

Update a database

Update a SQL user's password

Update a JWT Issuer

Update Client CA Cert for a cluster

Set the version upgrade deferral policy for a cluster

Set the maintenance window for a cluster

Set the AWS Endpoint Connection state

Set Client CA Cert for a cluster

Search person users by email address

Search groups

Search for a user by ID

Search a group by ID

Search Users

Scale, edit or upgrade a cluster

Return the SCIM Service Provider configuration

Replace the roles for a user or service account with exactly those provided

Remove a role from a user or service account

Remove a private endpoint trusted owner from a cluster

Patch a user by supplying partial updates

Patch a group by supplying partial updates

Resource type

Questions