Xata

Databases API key

Query and manage Xata databases, branches and tables from any Windmill script, flow or app.

Set up in 3 steps

Create an API key

In your Xata account settings, open API Keys and create one. Copy it — it is shown only once.

Add the resource in Windmill

Open Resources, add a resource of type xata, 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.

Resource type

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

View raw schema →

Field	Type	Required	What it is
apiKey	string	Yes	API key generated from the account settings of Xata dashboard.

Questions

What can the key do?

Everything your own account can, across every workspace you belong to. Xata has no per-key scopes.

A script asks for a workspace URL

Most of the data-plane scripts build their request from a per-workspace API host, which the resource does not carry yet — you will have to pass it, or use the scripts that only need the key. The workspace URL is on your Xata workspace's settings page.

Is my key 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

updates an access apiKey for a third party app

delete an access apiKey for a third party app

Upsert record with ID

Updates an existing invite

Update workspace settings

Update workspace member role

Update user info

Update table schema

Update table

Update record with ID

Update database settings

Update column

Update branch metadata

Update an existing workspace

Update Database metadata

Update Branch schema

Unlink a git branch to a Xata branch

SQL query

Resolve a Git Branch to a Xata branch

Resend Invite notification

Rename Database

Remove the content from a file column

Remove a member from the workspace

Query schema history.

Push migrations.

Preview branch schema edits.

Move the branch to a different cluster

List table columns

List git branches mapping

List databases

Resource type

Questions