Update Repository Settings

Change the default branch of the repository identified by the JWT repo claim.

The gateway reads the current HEAD symbolic ref, then repoints it at the requested branch through a transactional compare-and-swap against that value, and finally records the new default branch in the repository row. Branch names are fully qualified for you: main is written as the symref target refs/heads/main, and a value that already starts with refs/ is used verbatim. The branch itself is not created by this call.

JWT claims

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

PATCH

api

repos

{repo_name}

Update Repository Settings

curl --request PATCH \
  --url https://api.{cluster}.code.storage/api/repos/{repo_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_branch": "main"
}
'

import requests

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

payload = { "default_branch": "main" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({default_branch: 'main'})
};

fetch('https://api.{cluster}.code.storage/api/repos/{repo_name}', 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/repos/{repo_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'default_branch' => 'main'
  ]),
  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/repos/{repo_name}"

	payload := strings.NewReader("{\n  \"default_branch\": \"main\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.{cluster}.code.storage/api/repos/{repo_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"default_branch\": \"main\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"default_branch\": \"main\"\n}"

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

{
  "default_branch": "main",
  "id": "repo_7f2b3d9",
  "url": "pierre/sdk-documentation"
}

{
  "detail": "default_branch is required",
  "error": "default_branch is required",
  "instance": "/api/repos/my-demo-repository",
  "status": 400,
  "title": "Bad Request",
  "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>"
}

{
  "detail": "default branch was modified concurrently, please retry",
  "error": "default branch was modified concurrently, please retry",
  "instance": "/api/repos/my-demo-repository",
  "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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Repository settings to change. default_branch is the only supported field and must be a non-empty branch name.

Repository settings to patch, such as the default branch.

default_branch

string

New default branch name for the Code Storage repository.

Example:

"main"

Response

Default branch updated. Returns the repository ID, its URL path, and the branch name now recorded as the default.

Repository state after applying the patch.

default_branch

string

required

Updated default branch name.

Example:

"main"

string

required

Internal repository ID.

Example:

"repo_7f2b3d9"

url

string

required

Repository URL path. Matches the JWT repo claim.

Example:

"pierre/sdk-documentation"

Update Repository Settings

curl --request PATCH \
  --url https://api.{cluster}.code.storage/api/repos/{repo_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_branch": "main"
}
'

import requests

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

payload = { "default_branch": "main" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({default_branch: 'main'})
};

fetch('https://api.{cluster}.code.storage/api/repos/{repo_name}', 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/repos/{repo_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'default_branch' => 'main'
  ]),
  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/repos/{repo_name}"

	payload := strings.NewReader("{\n  \"default_branch\": \"main\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.{cluster}.code.storage/api/repos/{repo_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"default_branch\": \"main\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"default_branch\": \"main\"\n}"

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

{
  "default_branch": "main",
  "id": "repo_7f2b3d9",
  "url": "pierre/sdk-documentation"
}

{
  "detail": "default_branch is required",
  "error": "default_branch is required",
  "instance": "/api/repos/my-demo-repository",
  "status": 400,
  "title": "Bad Request",
  "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>"
}

{
  "detail": "default branch was modified concurrently, please retry",
  "error": "default branch was modified concurrently, please retry",
  "instance": "/api/repos/my-demo-repository",
  "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

Guides

Reference

Update Repository Settings

JWT claims

Authorizations

Path Parameters

Body

Response