Skip to content
forgit api docs

Delete a branch

DELETE
/repositories/{workspace}/{repo_slug}/refs/branches/{name}

Delete a branch in the specified repository.

The main branch is not allowed to be deleted and will return a 400 response.

The branch name should not include any prefixes (e.g. refs/heads).

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
name
required
string

The name of the branch.

repo_slug
required
string

This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Responses

Section titled “ Responses ”

204

Section titled “ 204 ”

Indicates that the specified branch was successfully deleted.

403

Section titled “ 403 ”

If the repository is private and the authenticated user does not have access to it.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

404

Section titled “ 404 ”

The specified repository or branch does not exist.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}