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
PUThttps://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/metadata
Update the branch metadata
Request Body Type Definition
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
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;
Status Code | Description | Example Response/Type Definition |
---|---|---|
204 | No Content | |
400 | Bad Request |
|
401 | Authentication Error |
|
404 | Example response |
|
5XX | Unexpected Error |
Get Branch Metadata
GEThttps://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/metadata
Status Code | Description | Example Response/Type Definition |
---|---|---|
200 | OK |
|
400 | Bad Request |
|
401 | Authentication Error |
|
404 | Example response |
|
5XX | Unexpected Error |