Create Branch

Create a new branch from an existing branch or ref. This is useful for agent workflows, ephemeral previews, or server-side automation where you do not want to clone the repo first.

JWT claims

Required scopes: git:write
Requires per repo scope: Yes

Deprecated: Use /api/repos/{repo_name}/branches/create instead.

POST /api/v1/repos/branches/create

Create Branch

cURL

curl --request POST \
  --url https://api.{cluster}.code.storage/api/v1/repos/branches/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base_branch": "main",
  "base_is_ephemeral": false,
  "target_branch": "feature/new-onboarding",
  "target_is_ephemeral": false
}
'

200

{
  "commit_sha": "abc123def4567890abc123def4567890abc123de",
  "message": "branch created",
  "target_branch": "feature/new-onboarding",
  "target_is_ephemeral": false
}

Authorizations

Authorization · string · header · required

JWT bearer token signed with your organization's registered signing key. There is no OAuth authorization server; you mint tokens yourself and the token's scopes claim carries the granted permission scopes. Public scopes: git:read (read repository contents), git:write (write branches, commits, tags, and notes), repo:write (create and manage repositories), org:read (list an organization's repositories). Each operation's security requirement names the scopes it requires. See https://code.storage/docs/getting-started/authentication for how to mint tokens.

Body

application/json

Create a branch from another branch or ref. The source and destination can live in the default namespace or the ephemeral namespace.

Create-branch request body describing the new branch and its base ref.

target_branch · string · required

Destination branch name.

Example:

"feature/new-onboarding"

base_branch · string · deprecated

Deprecated: use base_ref. Preferred source branch name.

Example:

"main"

base_is_ephemeral · boolean

Whether the base branch should be resolved from the ephemeral namespace.

Example:

false

base_ref · string

Optional source ref or revision. Provide base_ref or the deprecated base_branch.

force · boolean

Allow non-fast-forward updates when recreating an existing branch.

preferred_base · string

Optional pack hint. A branch name the backend prefers as the delta base when it builds the thin pack. It does not change the source or the result.

target_is_ephemeral · boolean

Whether the new branch should be created in the ephemeral namespace.

Example:

false

Response

200

application/json

Branch creation result.

Result of creating a branch, including the resulting ref state.

message · string · required

Human-readable result message.

Example:

"branch created"

target_branch · string · required

Destination branch name.

Example:

"feature/new-onboarding"

target_is_ephemeral · boolean · required

Whether the created branch is ephemeral.

Example:

false

commit_sha · string

Resolved commit SHA at the new branch tip.

Example:

"abc123def4567890abc123def4567890abc123de"