Skip to content

List the build cache entries of a CI runner pool

GET
/api/v3/organizations/{organisation}/resources/{resource}/cache
curl --request GET \
--url 'https://dashboard.quantcdn.io/api/v3/organizations/test-org/resources/cr-0123456789abcdef/cache?ref=refs%2Fheads%2Fmain' \
--header 'Authorization: Bearer <token>'

Lists the GitHub Actions cache entries of a CI runner pool, in storage order (repository id, then ref, version and key). totalBytes and entryCount cover every entry that matches the filter, not only this page; on a very large cache the count stops after about 10 seconds and totalsComplete is false. A page holds at most 500 entries; pass nextCursor as cursor, with the same filter, until it is null. repo is null when no repository name is recorded.

organisation
required
string

The organisation ID

Example
test-org
resource
required
string

The CI runner pool resource ID

Example
cr-0123456789abcdef
repoId
integer format: int64

Only the entries of this GitHub repository id.

ref
string
<= 512 characters
Example
refs/heads/main

Only the entries saved by this git ref. Needs repoId. Must start with refs/ and be a valid git ref name without %.

cursor
string

Opaque nextCursor from the previous page of the same filter.

The entries

Media typeapplication/json
CI build cache entries
object
totalBytes
required

Size of every entry that matches the filter (partial when totalsComplete is false).

integer format: int64
entryCount
required

Number of entries that match the filter (partial when totalsComplete is false).

integer format: int64
totalsComplete
required

False when the count stopped at its time limit (about 10 seconds) on a very large cache; totalBytes and entryCount then cover only the part counted.

boolean
entries
required
Array<object>
<= 500 items
CI build cache entry
object
repoId
required

GitHub repository id.

integer format: int64
repo
required

Owner/name recorded for repoId, or null when none is recorded.

string
nullable
ref
required

The git ref that saved the entry. A pull request saves to refs/pull//merge.

string
key
required

The actions/cache key.

string
version
required

The cache version (a hash of the paths and compression the job used).

string
sizeBytes
required
integer format: int64
createdAt
required

When the entry was saved. Entries expire 14 days after they are saved.

string format: date-time
nullable
nextCursor
required

Opaque. Pass as cursor, with the same filter, for the next page; null on the last page.

string
nullable
Example
{
"entries": [
{
"repoId": 123456,
"repo": "acme/web",
"ref": "refs/heads/main",
"key": "node-cache-Linux-x64-npm-abc",
"version": "a1b2c3",
"sizeBytes": 104857600
}
]
}

The cursor is not valid for this filter

Cloud access required

Resource not found, the resource is not a CI runner pool, or the organisation does not have CI runners

RepoId is not a non-negative integer, or ref is not valid or is sent without repoId

The build cache service is unavailable