repos.get

Fetch the metadata of a repository.

Scope: git:read on the repository.

GET /api/repos/{repo_name}

TypeScript

TypeScript

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

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

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

200

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

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

The repository name, for example acme/web.

Response

200

application/json

Repository metadata resolved from the JWT repo claim.

A repository, including its Git Sync upstream when one is configured.

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 · deprecated

Deprecated: use upstream. The upstream of the repository, when it has one.

Show child attributes

upstream · object

External Git host that the repository keeps syncing from. Absent when the repository has no upstream.

Show child attributes