Authentication
Get the list of user API keys
Create and return new API key
Delete an existing API key
OAuth
Get the list of user OAuth Clients
Delete the oauth client for the user
Get the list of user OAuth Access Tokens
delete an access token for a third party app
updates an access token for a third party app
Workspaces
Get list of workspaces
Create a new workspace
Get an existing workspace
Update an existing workspace
Delete an existing workspace
Get workspace settings
Update workspace settings
Get the list members of a workspace
Update workspace member role
Remove a member from the workspace
Invites
Invite a user to join the workspace
Updates an existing invite
Deletes an invite
Accept the invitation to join a workspace
Resend Invite notification
Databases
List databases
Create Database
Delete Database
Get Database metadata
Update Database metadata
Rename Database
List available regions
Branch
List branches
Get branch schema and metadata
Create Database branch
Delete Database branch
Update branch metadata
Get Branch Metadata
Branch stats
List git branches mapping
Link a git branch to a Xata branch
Unlink a git branch to a Xata branch
Resolve a Git Branch to a Xata branch
Migrations
Get branch migration history [deprecated]
Compute migration plan [deprecated]
Migrate branch [deprecated]
Query schema history.
Compare branch with user schema.
Compare branch schemas.
Update Branch schema
Preview branch schema edits.
Apply edit script.
Push migrations.
Table
Create table
Delete table
Update table
Get table schema
Update table schema
List table columns
Create new column
Get column information
Update column
Delete column
Records
Execute a transaction on a branch
Insert record
Get record by ID
Insert record with ID
Update record with ID
Upsert record with ID
Delete record from table
Bulk insert records
Files
Download content from a file item in a file array column
Upload or update the content of a file item in a file array column
Delete an item from a file array
Download content from a file column
Upload content to a file column
Remove the content from a file column
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/migrationsThis path allows access to migrations on a given database branch.
| Name | Description | In | Required | Schema |
|---|---|---|---|---|
db_branch_name | The DBBranchName matches the pattern `{db_name}:{branch_name}`. | path | ✅ | string |
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/migrations