repos.branches.delete

DELETE

api

repos

{repo_name}

branches

TypeScript

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

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

const result = await pierre.repos.branches.delete({
  repo_name: 'my-demo-repository',
  target_branch: 'feature/old-onboarding',
});
console.log(result);

from pierre import Pierre

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

result = pierre.repos.branches.delete(
    repo_name="my-demo-repository",
    target_branch="feature/old-onboarding",
)
print(result)

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
}
result, err := client.Repos.Branches.Delete(ctx, pierre.ReposBranchesDeleteParams{
	RepoName:     "my-demo-repository",
	TargetBranch: pierre.String("feature/old-onboarding"),
})
if err != nil {
	return err
}
fmt.Println(result)

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

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "name": "deployment.production_branch",
      "reason": "exceeds 255 characters"
    }
  ]
}

{
  "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": "cannot delete the default branch",
  "error": "cannot delete the default branch",
  "instance": "/api/repos/dotfiles/branches",
  "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>"
}

{
  "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

git:write

Path Parameters

repo_name

string

required

The repository name, for example acme/web.

Query Parameters

target_branch

string

Exact short name of the branch to delete. Must not start with refs/. Required unless the deprecated body names the branch.

ephemeral

boolean

When true, delete the branch from the ephemeral namespace instead of the default namespace.

Body

application/json

Deprecated: send the target_branch and ephemeral query parameters, and no body. A query parameter wins over its body field.

Deprecated branch deletion body. Use the target_branch and ephemeral query parameters.

ephemeral

boolean

deprecated

Deprecated: use the ephemeral query parameter. Delete the branch from the ephemeral namespace instead of the default namespace.

Example:

false

name

string

deprecated

Deprecated: use the target_branch query parameter. Branch name to delete.

Example:

"feature/old-onboarding"

target_branch

string

deprecated

Deprecated: use the target_branch query parameter. Branch name to delete. Must not start with refs/.

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"

TypeScript

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

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

const result = await pierre.repos.branches.delete({
  repo_name: 'my-demo-repository',
  target_branch: 'feature/old-onboarding',
});
console.log(result);

from pierre import Pierre

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

result = pierre.repos.branches.delete(
    repo_name="my-demo-repository",
    target_branch="feature/old-onboarding",
)
print(result)

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
}
result, err := client.Repos.Branches.Delete(ctx, pierre.ReposBranchesDeleteParams{
	RepoName:     "my-demo-repository",
	TargetBranch: pierre.String("feature/old-onboarding"),
})
if err != nil {
	return err
}
fmt.Println(result)

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

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "name": "deployment.production_branch",
      "reason": "exceeds 255 characters"
    }
  ]
}

{
  "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": "cannot delete the default branch",
  "error": "cannot delete the default branch",
  "instance": "/api/repos/dotfiles/branches",
  "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>"
}

{
  "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

Authorizations

Scopes

Path Parameters

Query Parameters

Body

Response