Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Branch

Create Branch

Creates a branch. Idempotent on retry: if a branch with the same name already exists in the workspace, the existing branch is returned instead of an error, so a repeated or retried request for the same branch succeeds rather than failing. Note: the duplicate-name check is a best-effort query and does not guarantee a single branch under truly simultaneous creates.

post/branch

Request body

idstring

Unique ID for this branch

branch_type'feature' | 'snapshot'

The type of branch

namestring

The name of the branch. Must be unique within workspace.

status'merged' | 'open' | 'snapshot'

The current status of the branch

application_idstring

The ID of the application associated with this branch

environment_idstring

Optional id of environment this branch is associated with, if any

branched_fromstring

The branch this branch was created from

workspace_idstring

Workspace this branch exists in

created_timeinteger

Time at which the deployment was created

created_by_idstring

The ID of the user who created this deployment

Response

The branch that was created, or the existing branch if one already had this name

idstring

Unique ID for this branch

branch_type'feature' | 'snapshot'

The type of branch

namestring

The name of the branch. Must be unique within workspace.

status'merged' | 'open' | 'snapshot'

The current status of the branch

application_idstring

The ID of the application associated with this branch

environment_idstring

Optional id of environment this branch is associated with, if any

branched_fromstring

The branch this branch was created from

workspace_idstring

Workspace this branch exists in

created_timeinteger

Time at which the deployment was created

created_by_idstring

The ID of the user who created this deployment