Sign in

v4

latestOpenAPI 3.0.02026-07-316584128.0 KB
Branches

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

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.

regionstring required

Geographic region where the branch is deployed

publicAccessboolean required

Whether the branch allows public access without authentication