Delete Branch

Delete a branch from the repository. The default branch is protected and cannot be deleted through this endpoint.

JWT claims

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

DELETE /api/repos/{repo_name}/branches

Delete Branch

cURL

curl --request DELETE \
  --url https://api.{cluster}.code.storage/api/repos/{repo_name}/branches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ephemeral": false,
  "name": "feature/old-onboarding",
  "target_branch": "feature/old-onboarding"
}
'

200

{
  "ephemeral": false,
  "message": "branch deleted",
  "name": "feature/old-onboarding",
  "target_branch": "feature/old-onboarding"
}

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.

Path Parameters

repo_name · string · required

Repository name. Names that contain / or any other character that is not safe in a URL path segment must be URL encoded so the value occupies a single path segment. For example pierre/example is sent as pierre%2Fexample. Plain names such as example can be sent as-is. The server URL-decodes the value before resolving the repository.

Body

application/json

Delete a branch by name. The server resolves the current branch tip before deleting, so the caller does not need the branch SHA.

Branch deletion request identifying the branch to remove.

ephemeral · boolean

Delete the branch from the ephemeral namespace instead of the default namespace.

Example:

false

name · string · deprecated

Deprecated: use target_branch. Branch name to delete.

Example:

"feature/old-onboarding"

target_branch · string

Branch name to delete. Must not start with refs/. Provide target_branch or the deprecated name.

Example:

"feature/old-onboarding"

Response

200

application/json

Branch deletion result.

Result of deleting a branch.

ephemeral · boolean · required

Whether the deleted branch lived in the ephemeral namespace.

Example:

false

message · string · required

Human-readable result message.

Example:

"branch deleted"

name · string · required · deprecated

Deprecated: use target_branch. Deleted branch name.

Example:

"feature/old-onboarding"

target_branch · string · required

Deleted branch name.

Example:

"feature/old-onboarding"