Delete Branch

DELETE

api

repos

branches

Delete Branch

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

import requests

url = "https://api.{cluster}.code.storage/api/v1/repos/branches"

payload = {
    "ephemeral": False,
    "name": "feature/old-onboarding",
    "target_branch": "feature/old-onboarding"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ephemeral: false,
    name: 'feature/old-onboarding',
    target_branch: 'feature/old-onboarding'
  })
};

fetch('https://api.{cluster}.code.storage/api/v1/repos/branches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{cluster}.code.storage/api/v1/repos/branches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'ephemeral' => false,
    'name' => 'feature/old-onboarding',
    'target_branch' => 'feature/old-onboarding'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{cluster}.code.storage/api/v1/repos/branches"

	payload := strings.NewReader("{\n  \"ephemeral\": false,\n  \"name\": \"feature/old-onboarding\",\n  \"target_branch\": \"feature/old-onboarding\"\n}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.{cluster}.code.storage/api/v1/repos/branches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ephemeral\": false,\n  \"name\": \"feature/old-onboarding\",\n  \"target_branch\": \"feature/old-onboarding\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{cluster}.code.storage/api/v1/repos/branches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ephemeral\": false,\n  \"name\": \"feature/old-onboarding\",\n  \"target_branch\": \"feature/old-onboarding\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "detail": "cannot delete the default branch",
  "error": "cannot delete the default branch",
  "instance": "/api/repos/dotfiles/branches",
  "status": 409,
  "title": "Conflict",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

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

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

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"

Delete Branch

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

import requests

url = "https://api.{cluster}.code.storage/api/v1/repos/branches"

payload = {
    "ephemeral": False,
    "name": "feature/old-onboarding",
    "target_branch": "feature/old-onboarding"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ephemeral: false,
    name: 'feature/old-onboarding',
    target_branch: 'feature/old-onboarding'
  })
};

fetch('https://api.{cluster}.code.storage/api/v1/repos/branches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{cluster}.code.storage/api/v1/repos/branches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'ephemeral' => false,
    'name' => 'feature/old-onboarding',
    'target_branch' => 'feature/old-onboarding'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{cluster}.code.storage/api/v1/repos/branches"

	payload := strings.NewReader("{\n  \"ephemeral\": false,\n  \"name\": \"feature/old-onboarding\",\n  \"target_branch\": \"feature/old-onboarding\"\n}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.{cluster}.code.storage/api/v1/repos/branches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ephemeral\": false,\n  \"name\": \"feature/old-onboarding\",\n  \"target_branch\": \"feature/old-onboarding\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{cluster}.code.storage/api/v1/repos/branches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ephemeral\": false,\n  \"name\": \"feature/old-onboarding\",\n  \"target_branch\": \"feature/old-onboarding\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "detail": "cannot delete the default branch",
  "error": "cannot delete the default branch",
  "instance": "/api/repos/dotfiles/branches",
  "status": 409,
  "title": "Conflict",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Getting Started

Features

Workflows

Reference

JWT claims

Authorizations

Body

Response