Skip to main content
GET
List references

Authorizations

Authorization
string
header
required

Bearer token authorizing this operation's repository action. Each operation's security requirement names the resource action the token must be authorized for (pull or push).

Path Parameters

repoId
string
required

Repository ULID.

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

Query Parameters

prefix
string[] | null

Ref-name prefixes to filter by (repeatable), e.g. "refs/heads/", "refs/tags/", "HEAD". Empty returns all visible refs.

Maximum array length: 100
symrefs
boolean
default:false

Include the symref target for symbolic refs.

peel
boolean
default:false

Include the peeled commit for annotated tags.

unborn
boolean
default:false

Emit an unborn HEAD (a symbolic HEAD whose branch has no commits yet).

pageSize
integer<int32>

Max refs to return (default 100, max 500).

Required range: 0 <= x <= 500
pageToken
string

Response

OK

refs
object[] | null
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://aws-us-east-2.entire.io/api/v1/schemas/ListRefsResponse.json"

nextPageToken
string