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

NameDescriptionInRequiredSchema
db_branch_name

Failed to compile MDX

pathstring

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;

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"
    ]
}