Create a new branch

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

Try it

Create a new branch

cURL

curl --request POST \
  --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "inherit",
  "parentID": "<string>",
  "name": "<string>",
  "description": "<string>",
  "scaleToZero": {
    "enabled": true,
    "inactivityPeriodMinutes": 30
  },
  "backupConfiguration": {
    "retentionPeriod": 2,
    "backupTime": "<string>"
  }
}
'

201

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "region": "<string>",
  "publicAccess": true,
  "description": "<string>",
  "parentID": "<string>",
  "connectionString": "<string>"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organizationID · string · required

Unique identifier of the organization containing the project

projectID · string · required

Unique identifier of the project to create the branch in

Body

application/json

Option 1

Details required when creating a new branch

mode · enum<string> · required

The mode used to discriminate between types of branches.

Available options: inherit

parentID · string · required

If present, the branch will inherit the parent branch configuration and data

name · string · required

Human-readable name for the new branch

description · string

Optional description for the branch purpose or contents (max 50 characters)

Maximum string length: 50

scaleToZero · object

Configuration for scaling branches to zero when not in use

Show child attributes

scaleToZero. enabled · boolean · required

Whether scale to zero is enabled

scaleToZero. inactivityPeriodMinutes · integer · default: 30 · required

Duration in minutes after which branches will be hibernated if not accessed

backupConfiguration · object

Details about the branch continuous backup configuration

Show child attributes

backupConfiguration. retentionPeriod · integer<int32> · default: 2

how long are we keeping the backups around for

Required range: 2 <= x <= 35

backupConfiguration. backupTime · string

time of day/week when we are taking a full backup

Response

201

application/json

Branch successfully created

Basic metadata about a branch, used in response to create/update operations

id · string · required

Unique identifier for the branch

name · string · required

Human-readable name of the branch

createdAt · string<date-time> · required

Timestamp when the branch was created

updatedAt · string<date-time> · required

Timestamp when the branch was last updated

region · string · required

Geographic region where the branch is deployed

publicAccess · boolean · required

Whether the branch allows public access without authentication

description · string

Optional description of the branch purpose or contents

parentID · string | null

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

connectionString · string | null

Database connection string for accessing this branch