Branch Metadata

Users

Get user details

Update user info

Delete user

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 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

Apply a pgroll migration

Get pgroll status

Get pgroll job status

Get pgroll migration history

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

Search and Filter

Query table

Free text search

Free text search in a table

Vector similarity search in a table

Ask your table a question

Continue a conversation with your data

Summarize table

Run aggregations over a table

SQL

SQL query

Branch Metadata

https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/metadata

This path allows interacting with the metadata of a specific database branch.

Expected parameters

Name	Description	In	Required	Schema
`db_branch_name`	The DBBranchName matches the pattern `{db_name}:{branch_name}`.	path	✅	string

Update Branch Metadata

PUT

https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/metadata

Update the branch metadata

Request Body Type Definition

type UpdateBranchMetadata = BranchMetadata;
 
/**
 * @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
 */
type BranchMetadata = {
    /**
     * @minLength 1
     */
    repository?: string;
    branch?: BranchName;
    /**
     * @minLength 1
     */
    stage?: string;
    labels?: string[];
};
 
/**
 * @maxLength 255
 * @minLength 1
 * @pattern [a-zA-Z0-9_\-~]+
 */
type BranchName = string;

Responses

type UpdateBranchMetadata = void;

type UpdateBranchMetadata = {
    id?: string;
    message: string;
};

{
    "message": "invalid API key"
}

type UpdateBranchMetadata = {
    id?: string;
    message: string;
};

type UpdateBranchMetadata = void;

type UpdateBranchMetadata = void;

Get Branch Metadata

GET

https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/metadata

Responses

{
    "repository": "github.com/my/repository",
    "branch": "feature-login",
    "stage": "testing",
    "labels": [
        "epic-100"
    ]
}

type GetBranchMetadata = {
    id?: string;
    message: string;
};

{
    "message": "invalid API key"
}

type GetBranchMetadata = {
    id?: string;
    message: string;
};

type GetBranchMetadata = void;

type GetBranchMetadata = void;