Skip to content
forgit api docs

List GitHub Actions caches for a repository

GET
/repos/{owner}/{repo}/actions/caches

Lists the GitHub Actions caches for a repository.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

The account owner of the repository. The name is not case sensitive.

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

Query Parameters

Section titled “ Query Parameters ”
per_page
integer
default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page
integer
default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

ref
string

The full Git reference for narrowing down the cache. The ref for a branch should be formatted as refs/heads/<branch name>. To reference a pull request use refs/pull/<number>/merge.

key
string

An explicit key or prefix for identifying the cache

sort
string
default: last_accessed_at
Allowed values: created_at last_accessed_at size_in_bytes

The property to sort the results by. created_at means when the cache was created. last_accessed_at means when the cache was last accessed. size_in_bytes is the size of the cache in bytes.

direction
string
default: desc
Allowed values: asc desc

The direction to sort the results by.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Repository actions caches

Repository actions caches

object
total_count
required

Total number of caches

integer
actions_caches
required

Array of caches

Array<object>
object
id
integer
ref
string
key
string
version
string
last_accessed_at
string format: date-time
created_at
string format: date-time
size_in_bytes
integer
Examples
Example default 
{
  "total_count": 1,
  "actions_caches": [
    {
      "id": 505,
      "ref": "refs/heads/main",
      "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b",
      "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0",
      "last_accessed_at": "2019-01-24T22:45:36.000Z",
      "created_at": "2019-01-24T22:45:36.000Z",
      "size_in_bytes": 1024
    }
  ]
}

Headers

Section titled “ Headers ”
Link
string
Example 
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"