repos.update

Change the default branch of a repository.

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.

Scope: repo:write on the repository.

PATCH

api

repos

{repo_name}

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

const repo = await pierre.repos.update({
  repo_name: 'my-demo-repository',
  default_branch: 'main',
});
console.log(repo);

from pierre import Pierre

# The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
pierre = Pierre()

repo = pierre.repos.update(
    repo_name="my-demo-repository",
    default_branch="main",
)
print(repo)

import (
	"context"
	"fmt"

	pierre "github.com/pierrecomputer/sdk/go"
)

ctx := context.Background()
// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
client, err := pierre.NewClient()
if err != nil {
	return err
}
repo, err := client.Repos.Update(ctx, pierre.ReposUpdateParams{
	RepoName:      "my-demo-repository",
	DefaultBranch: pierre.String("main"),
})
if err != nil {
	return err
}
fmt.Println(repo)

curl -X PATCH \
  "https://api.{org}.code.storage/api/repos/my-demo-repository" \
  -H "Authorization: Bearer $PIERRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "default_branch": "main"
  }'

{
  "default_branch": "main",
  "repo_name": "pierre/sdk-documentation"
}

{
  "code": "bad_request",
  "detail": "default_branch must be a string",
  "error": "default_branch must be a string",
  "invalid_params": [
    {
      "name": "default_branch",
      "reason": "must be a string"
    }
  ],
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

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

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

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

{
  "code": "conflict",
  "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"
}

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

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

{
  "code": "<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.

Scopes

repo:write

Path Parameters

repo_name

string

required

The repository name, for example acme/web.

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

deprecated

Deprecated: use repo_name. Stable repository identifier.

Example:

"repo_7f2b3d9"

repo_id

string

required

deprecated

Deprecated: use repo_name. Stable repository identifier.

Example:

"repo_7f2b3d9"

repo_name

string

required

Repository name or path. It can contain a slash. It matches the JWT repo claim.

Example:

"pierre/sdk-documentation"

url

string

required

deprecated

Deprecated: use repo_name. Repository name or path, not a full URL.

Example:

"pierre/sdk-documentation"

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

const repo = await pierre.repos.update({
  repo_name: 'my-demo-repository',
  default_branch: 'main',
});
console.log(repo);

from pierre import Pierre

# The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
pierre = Pierre()

repo = pierre.repos.update(
    repo_name="my-demo-repository",
    default_branch="main",
)
print(repo)

import (
	"context"
	"fmt"

	pierre "github.com/pierrecomputer/sdk/go"
)

ctx := context.Background()
// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
client, err := pierre.NewClient()
if err != nil {
	return err
}
repo, err := client.Repos.Update(ctx, pierre.ReposUpdateParams{
	RepoName:      "my-demo-repository",
	DefaultBranch: pierre.String("main"),
})
if err != nil {
	return err
}
fmt.Println(repo)

curl -X PATCH \
  "https://api.{org}.code.storage/api/repos/my-demo-repository" \
  -H "Authorization: Bearer $PIERRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "default_branch": "main"
  }'

{
  "default_branch": "main",
  "repo_name": "pierre/sdk-documentation"
}

{
  "code": "bad_request",
  "detail": "default_branch must be a string",
  "error": "default_branch must be a string",
  "invalid_params": [
    {
      "name": "default_branch",
      "reason": "must be a string"
    }
  ],
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

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

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

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

{
  "code": "conflict",
  "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"
}

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

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

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

Getting Started

Platform

Workflows

Libraries

API Reference

repos.update

Authorizations

Scopes

Path Parameters

Body

Response