XAxataio
Branches

Create a new branch

Changed on

Creates a new branch within the specified project. Branches can be created from scratch or derived from an existing parent branch.

post/organizations/{organizationID}/projects/{projectID}/branches

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: branch:write

Path parameters

organizationIDstring required

Unique identifier of the organization containing the project

projectIDstring required

Unique identifier of the project to create the branch in

Request body

OR

Response

Branch successfully created

idstring required

Unique identifier for the branch

namestring required

Human-readable name of the branch

descriptionstring

Optional description of the branch purpose or contents

createdAtstring date-time required

Timestamp when the branch was created

updatedAtstring date-time required

Timestamp when the branch was last updated

parentIDstring nullable

Identifier of the parent branch if this is a derived branch, null otherwise

connectionStringstring nullable

Deprecated: retrieve the connection string from the branch credentials endpoint (GET .../branches/{branchID}/credentials) instead. The hostname in this connection string carries a -deprecated marker in its first DNS label.

regionstring required

Geographic region where the branch is deployed

publicAccessboolean required

Whether the branch allows public access without authentication

Changes

  • e6493d6906d1Revision changes
    • warning

      changed the pattern of the request property from ^[a-zA-Z0-9]+[a-zA-Z0-9- ]*$ to ^([a-zA-Z0-9][a-zA-Z0-9\-_./: ]*)?$

    • info

      the request property's maxLength was increased from 50 to 255

  • 16f6200eae92Revision changes
    • info

      response property connectionString deprecated