Skip to main content
GET
Get repository

Authorizations

Authorization
string
header
required

Authorization code flow with PKCE-S256. RFC 8628 device flow is also supported.

Path Parameters

repoId
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Query Parameters

authoritative
boolean

Require the repo's regional lifecycle state. A local repo is unaffected. A repo homed in another jurisdiction redirects with 421. This core reports 503 when it cannot route the read. Provisioning and failed states still return 200.

commitToken
string

Optional: opaque commit token from this repo's create, to read at a snapshot that contains that write. The lifecycle state, the placements, and a provisioning failure are always read fresh.

Pattern: ^$|^[A-Za-z0-9_-]{60,512}$

Response

OK

capabilities
object
required
id
string
required
name
string
required
owningProjectId
string
required
provider
enum<string>
required
Available options:
github,
entire
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"/api/v1/schemas/Repo.json"

candidate
object
clusterHost
string
clusterSlug
string
detachedAt
string<date-time>
foreign
boolean
fullName
string
jurisdiction
string
lastPushedAt
string<date-time>
mirrorSuspended
boolean
mirrorSuspendedAt
string
objectFormat
enum<string>
Available options:
sha1,
sha256
path
string
placements
object[]
primaries
object
provisionAttempts
integer<int64>
provisionReason
string
repoGroupId
string
state
enum<string>

Provisioning lifecycle. A mirror is active from creation, before its initial clone completes. A native primary reports deleting while a cascade delete removes its native mirrors; poll until 404.

Available options:
provisioning,
active,
failed,
deleting
visibility
enum<string>
Available options:
public,
private