List GitHub Actions caches for a repository | GitHub API (unofficial showcase)

8 parameters

ownerstringrequired

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

repostringrequired

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

per_pageintegeroptional

The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:30

pageintegeroptional

The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:1

refstringoptional

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`.

keystringoptional

An explicit key or prefix for identifying the cache

sortstringoptional

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.

Allowed:created_atlast_accessed_atsize_in_bytesDefault:last_accessed_at

directionstringoptional

The direction to sort the results by.

Allowed:ascdescDefault:desc

1 status code

200Response

total_countintegerrequired

Total number of caches

actions_cachesarray<object>required

Array of caches

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.caches.list({
  owner: "octocat",
  repo: "hello-world",
  perPage: 20,
  page: 1,
  ref: "main",
});

{
  "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
    }
  ]
}

Request

Response