Get GitHub Actions cache usage for a repository

GET

/repos/{owner}/{repo}/actions/cache/usage

Gets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///actions/cache/usage'

Response Example

{
    "active_caches_count": 3,
    "active_caches_size_in_bytes": 2322142,
    "full_name": "octo-org/Hello-World"
}

Request

Path Params

owner

string

required

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

repo

string

required

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

Responses

🟢200Response

application/json

Body

GitHub Actions Cache Usage by repository.

active_caches_count

integer

required

The number of active caches in the repository.

Example:

active_caches_size_in_bytes

integer

required

The sum of the size in bytes of all the active cache items in the repository.

Example:

2322142

full_name

string

required

The repository owner and name for the cache usage being shown.

Example:

octo-org/Hello-World

Modified at 2023-08-15 02:59:24

Download an artifact

Delete GitHub Actions caches for a repository (using a cache key)