Get Branch

Get one branch by its exact short name. The response omits list pagination fields.

JWT claims

Required scopes: git:read
Requires per repo scope: Yes

GET /api/repos/{repo_name}/branch

Get Branch

cURL

curl --request GET \
  --url https://api.{cluster}.code.storage/api/repos/{repo_name}/branch \
  --header 'Authorization: Bearer <token>'

200

{
  "branch": {
    "created_at": "2024-01-15T10:30:00Z",
    "head_sha": "a1b2c3d4e5f6",
    "name": "main"
  }
}

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.

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.

Query Parameters

name · string · required

Exact short branch name.

ephemeral · boolean

When true, get the branch from the ephemeral namespace.

Response

200

application/json

The branch with the requested name.

One branch that matches an exact short name.

branch · object · required

The branch that has the requested name.

Show child attributes