Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Branch

Get branch

Used to retrieve a branch by workspace and name

get/branch/{workspace_id}/{name}

Path parameters

workspace_idstring required

The ID of the workspace the branch is in

namestring required

The name of the branch to retrieve

Response

The branch with the given ID

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