NeonDB

Databases API key

Create and manage Neon projects, branches, databases and compute endpoints from any Windmill script, flow or app.

Set up in 3 steps

1

Create an API key

In the Neon console, open your account settings then API keys, and create one. Copy it — it is shown only once.

2

Add the resource in Windmill

Open Resources, add a resource of type neondb, and paste the key.

3

Run your first script

Fork any script below and read before writing anything. There are dozens 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.

Update the role for an organization member

Script neondb Verified

Update a project

Script neondb Verified

Update a database

Script neondb Verified

Update a compute endpoint

Script neondb Verified

Update a branch

Script neondb Verified

Transfer projects from your personal account to a specified destination account

Script neondb Verified

Suspend a compute endpoint

Script neondb Verified

Start a compute endpoint

Script neondb Verified

Set branch as default

Script neondb Verified

Revoke project access

Script neondb Verified

Revoke an organization API key

Script neondb Verified

Revoke an API key

Script neondb Verified

Returns all available JWKS URLs for a project

Script neondb Verified

Retrieve the state of a VPC endpoint configuration

Script neondb Verified

Restore a branch

Script neondb Verified

Restart a compute endpoint

Script neondb Verified

Reset the role password

Script neondb Verified

Remove member from the organization

Script neondb Verified

List project access

Script neondb Verified

Grant project access

Script neondb Verified

Get the list of VPC endpoints

Script neondb Verified

Get the list of VPC endpoint restrictions

Script neondb Verified

Get the database schema

Script neondb Verified

Get role password

Script neondb Verified

Get role details

Script neondb Verified

Get project details

Script neondb Verified

Get organization members details

Script neondb Verified

Get organization member details

Script neondb Verified

Get organization invitation details

Script neondb Verified

Get organization details

Script neondb Verified

Resource type

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

View raw schema →
FieldTypeRequiredWhat it is
apiKeystringYesAPI Key generated from the account settings of NeonDB console.

Questions

Is this for running SQL?

No. This manages projects and branches. To query a database, add a postgresql resource pointing at the branch's connection string — Windmill then runs SQL natively.

Branches are a good fit for jobs

A branch is a copy-on-write clone, so a flow can branch, run a migration against it, check the result and delete the branch without touching production.

Is my key stored on the hub?

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