Get Repo

Fetch repository metadata for the repository identified by the JWT repo claim.

JWT claims

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

GET /api/repos/{repo_name}

Get Repo

cURL

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

200

{
  "base_repo": {
    "name": "Hello-World",
    "owner": "octocat",
    "provider": "github"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "default_branch": "main",
  "repo_id": "repo_7f2b3d9",
  "repo_name": "team/project-alpha",
  "url": "team/project-alpha"
}

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.

Response

200

application/json

Repository metadata resolved from the JWT repo claim.

Detailed view of a single repository, including any Git Sync configuration.

created_at · string · required

ISO 8601 creation timestamp.

Example:

"2024-01-15T10:30:00Z"

default_branch · string · required

Default branch name.

Example:

"main"

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:

"team/project-alpha"

url · string · required · deprecated

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

Example:

"team/project-alpha"

base_repo · object

Git Sync configuration (if configured).

Show child attributes