NeonDB
Databases API keyCreate and manage Neon projects, branches, databases and compute endpoints from any Windmill script, flow or app.
Set up in 3 steps
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.
Add the resource in Windmill
Open Resources, add a resource of type neondb, and paste the key.
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
Update a project
Update a database
Update a compute endpoint
Update a branch
Transfer projects from your personal account to a specified destination account
Suspend a compute endpoint
Start a compute endpoint
Set branch as default
Revoke project access
Revoke an organization API key
Revoke an API key
Returns all available JWKS URLs for a project
Retrieve the state of a VPC endpoint configuration
Restore a branch
Restart a compute endpoint
Reset the role password
Remove member from the organization
List project access
Grant project access
Get the list of VPC endpoints
Get the list of VPC endpoint restrictions
Get the database schema
Get role password
Get role details
Get project details
Get organization members details
Get organization member details
Get organization invitation details
Get organization details
Resource type
neondb — the shape of the credential every script on this page expects.
| Field | Type | Required | What it is |
|---|---|---|---|
| apiKey | string | Yes | API 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.