Кэш GitHub Actions

Use the REST API to interact with the cache for repositories in GitHub Actions.

About the cache in GitHub Actions

You can use the REST API to query and manage the cache for repositories in GitHub Actions. You can also install a GitHub CLI extension to manage your caches from the command line. For more information, see "Caching dependencies to speed up workflows."

Get GitHub Actions cache usage for an enterprise

Gets the total GitHub Actions cache usage for an enterprise. 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. You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

Параметры для "Get GitHub Actions cache usage for an enterprise"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`enterprise` string Обязательное поле The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Коды состояния http-ответа для "Get GitHub Actions cache usage for an enterprise"

Код состояния	Description
`200`	OK

Примеры кода для "Get GitHub Actions cache usage for an enterprise"

get/enterprises/{enterprise}/actions/cache/usage

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/cache/usage

Response

Status: 200

{
  "total_active_caches_size_in_bytes": 3344284,
  "total_active_caches_count": 5
}

Get GitHub Actions cache usage policy for an enterprise

Gets the GitHub Actions cache usage policy for an enterprise. You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

Параметры для "Get GitHub Actions cache usage policy for an enterprise"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`enterprise` string Обязательное поле The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Коды состояния http-ответа для "Get GitHub Actions cache usage policy for an enterprise"

Код состояния	Description
`200`	OK

Примеры кода для "Get GitHub Actions cache usage policy for an enterprise"

get/enterprises/{enterprise}/actions/cache/usage-policy

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/cache/usage-policy

Response

Status: 200

{
  "repo_cache_size_limit_in_gb": 10,
  "max_repo_cache_size_limit_in_gb": 15
}

Set GitHub Actions cache usage policy for an enterprise

Sets the GitHub Actions cache usage policy for an enterprise. You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

Параметры для "Set GitHub Actions cache usage policy for an enterprise"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`enterprise` string Обязательное поле The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Параметры запроса
Имя, Вид, Description
`repo_cache_size_limit_in_gb` integer For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.
`max_repo_cache_size_limit_in_gb` integer For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.

Коды состояния http-ответа для "Set GitHub Actions cache usage policy for an enterprise"

Код состояния	Description
`204`	No Content

Примеры кода для "Set GitHub Actions cache usage policy for an enterprise"

patch/enterprises/{enterprise}/actions/cache/usage-policy

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/cache/usage-policy \
  -d '{"repo_cache_size_limit_in_gb":10,"max_repo_cache_size_limit_in_gb":15}'

Response

Status: 204

Get GitHub Actions cache usage for an organization

Совместим с GitHub Apps

Gets the total GitHub Actions cache usage for an organization. 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. You must authenticate using an access token with the read:org scope to use this endpoint. GitHub Apps must have the organization_admistration:read permission to use this endpoint.

Параметры для "Get GitHub Actions cache usage for an organization"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Коды состояния http-ответа для "Get GitHub Actions cache usage for an organization"

Код состояния	Description
`200`	OK

Примеры кода для "Get GitHub Actions cache usage for an organization"

get/orgs/{org}/actions/cache/usage

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/cache/usage

Response

Status: 200

{
  "total_active_caches_size_in_bytes": 3344284,
  "total_active_caches_count": 5
}

List repositories with GitHub Actions cache usage for an organization

Совместим с GitHub Apps

Lists repositories and their GitHub Actions cache usage for an organization. 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. You must authenticate using an access token with the read:org scope to use this endpoint. GitHub Apps must have the organization_admistration:read permission to use this endpoint.

Параметры для "List repositories with GitHub Actions cache usage for an organization"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Параметры запроса
Имя, Вид, Description
`per_page` integer The number of results per page (max 100). По умолчанию.: `30`
`page` integer Page number of the results to fetch. По умолчанию.: `1`

Коды состояния http-ответа для "List repositories with GitHub Actions cache usage for an organization"

Код состояния	Description
`200`	OK

Примеры кода для "List repositories with GitHub Actions cache usage for an organization"

get/orgs/{org}/actions/cache/usage-by-repository

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/actions/cache/usage-by-repository

Response

Status: 200

{
  "total_count": 2,
  "repository_cache_usages": [
    {
      "full_name": "octo-org/Hello-World",
      "active_caches_size_in_bytes": 2322142,
      "active_caches_count": 3
    },
    {
      "full_name": "octo-org/server",
      "active_caches_size_in_bytes": 1022142,
      "active_caches_count": 2
    }
  ]
}

Get GitHub Actions cache usage for a repository

Совместим с GitHub Apps

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.

Параметры для "Get GitHub Actions cache usage for a repository"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.

Коды состояния http-ответа для "Get GitHub Actions cache usage for a repository"

Код состояния	Description
`200`	OK

Примеры кода для "Get GitHub Actions cache usage for a repository"

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/cache/usage

Response

Status: 200

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

Get GitHub Actions cache usage policy for a repository

Совместим с GitHub Apps

Gets GitHub Actions cache usage policy for a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:read permission to use this endpoint.

Параметры для "Get GitHub Actions cache usage policy for a repository"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.

Коды состояния http-ответа для "Get GitHub Actions cache usage policy for a repository"

Код состояния	Description
`200`	OK

Примеры кода для "Get GitHub Actions cache usage policy for a repository"

get/repos/{owner}/{repo}/actions/cache/usage-policy

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/cache/usage-policy

Response

Status: 200

{
  "repo_cache_size_limit_in_gb": 14
}

Set GitHub Actions cache usage policy for a repository

Совместим с GitHub Apps

Sets GitHub Actions cache usage policy for a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

Параметры для "Set GitHub Actions cache usage policy for a repository"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.

Параметры запроса
Имя, Вид, Description
`repo_cache_size_limit_in_gb` integer Обязательное поле The size limit for the sum of all caches, in gigabytes.

Коды состояния http-ответа для "Set GitHub Actions cache usage policy for a repository"

Код состояния	Description
`204`	No Content

Примеры кода для "Set GitHub Actions cache usage policy for a repository"

patch/repos/{owner}/{repo}/actions/cache/usage-policy

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/cache/usage-policy \
  -d '{"repo_cache_size_limit_in_gb":14}'

Response

Status: 204

List GitHub Actions caches for a repository

Совместим с GitHub Apps

Lists the GitHub Actions caches for a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:read permission to use this endpoint.

Параметры для "List GitHub Actions caches for a repository"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.

Параметры запроса
Имя, Вид, Description
`per_page` integer The number of results per page (max 100). По умолчанию.: `30`
`page` integer Page number of the results to fetch. По умолчанию.: `1`
`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 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. По умолчанию.: `last_accessed_at` Возможные значения: `created_at`, `last_accessed_at`, `size_in_bytes`
`direction` string The direction to sort the results by. По умолчанию.: `desc` Возможные значения: `asc`, `desc`

Коды состояния http-ответа для "List GitHub Actions caches for a repository"

Код состояния	Description
`200`	OK

Примеры кода для "List GitHub Actions caches for a repository"

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/caches

Response

Status: 200

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

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

Совместим с GitHub Apps

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

You must authenticate using an access token with the repo scope to use this endpoint.

GitHub Apps must have the actions:write permission to use this endpoint.

Параметры для "Delete GitHub Actions caches for a repository (using a cache key)"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.

Параметры запроса
Имя, Вид, Description
`key` string Обязательное поле A key for identifying the cache.
`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`.

Коды состояния http-ответа для "Delete GitHub Actions caches for a repository (using a cache key)"

Код состояния	Description
`200`	OK

Примеры кода для "Delete GitHub Actions caches for a repository (using a cache key)"

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

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  "http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/caches?key=Linux-node-958aff96db2d75d67787d1e634ae70b659de937b"

Response

Status: 200

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

Delete a GitHub Actions cache for a repository (using a cache ID)

Совместим с GitHub Apps

Deletes a GitHub Actions cache for a repository, using a cache ID.

You must authenticate using an access token with the repo scope to use this endpoint.

GitHub Apps must have the actions:write permission to use this endpoint.

Параметры для "Delete a GitHub Actions cache for a repository (using a cache ID)"

Заголовки
Имя, Вид, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя, Вид, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.
`cache_id` integer Обязательное поле The unique identifier of the GitHub Actions cache.

Коды состояния http-ответа для "Delete a GitHub Actions cache for a repository (using a cache ID)"

Код состояния	Description
`204`	No Content

Примеры кода для "Delete a GitHub Actions cache for a repository (using a cache ID)"

delete/repos/{owner}/{repo}/actions/caches/{cache_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/caches/CACHE_ID

Response

Status: 204