Skip to main content
REST API はバージョン管理になりました。 詳細については、「API のバージョン管理について」を参照してください。

GitHub Actions キャッシュの REST API エンドポイント

この REST API を使って、GitHub Actions のリポジトリのキャッシュを操作します。

GitHub Actions

のキャッシュについて

この REST API を使うと、GitHub Actions 内のリポジトリのキャッシュを照会および管理できます。 GitHub CLI 拡張機能をインストールして、コマンド ラインからキャッシュを管理することもできます。 詳しくは、「依存関係をキャッシュしてワークフローのスピードを上げる」を参照してください。

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.

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

"Get GitHub Actions cache usage for an enterprise" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンには次のアクセス許可が設定されている必要があります:

  • "Enterprise administration" business permissions (write)

"Get GitHub Actions cache usage for an enterprise" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
enterprise string 必須

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

"Get GitHub Actions cache usage for an enterprise" の HTTP 応答状態コード

状態コード説明
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>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/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 for an organization

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.

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

"Get GitHub Actions cache usage for an organization" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンには次のアクセス許可が設定されている必要があります:

  • "Administration" organization permissions (read)

"Get GitHub Actions cache usage for an organization" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
org string 必須

The organization name. The name is not case sensitive.

"Get GitHub Actions cache usage for an organization" の HTTP 応答状態コード

状態コード説明
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>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/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

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.

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

"List repositories with GitHub Actions cache usage for an organization" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンには次のアクセス許可が設定されている必要があります:

  • "Administration" organization permissions (read)

"List repositories with GitHub Actions cache usage for an organization" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
org string 必須

The organization name. The name is not case sensitive.

クエリ パラメーター
名前, Type, 説明
per_page integer

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

Default: 30

page integer

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

Default: 1

"List repositories with GitHub Actions cache usage for an organization" の HTTP 応答状態コード

状態コード説明
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>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/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

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, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

"Get GitHub Actions cache usage for a repository" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンには次のアクセス許可が設定されている必要があります:

  • "Actions" repository permissions (read)

このエンドポイントは、パブリック リソースのみが要求される場合は、認証または前述メンションアクセス許可なしで使用できます。

"Get GitHub Actions cache usage for a repository" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
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.

"Get GitHub Actions cache usage for a repository" の HTTP 応答状態コード

状態コード説明
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>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/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 }

List GitHub Actions caches for a repository

Lists the GitHub Actions caches for a repository.

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

"List GitHub Actions caches for a repository" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンには次のアクセス許可が設定されている必要があります:

  • "Actions" repository permissions (read)

このエンドポイントは、パブリック リソースのみが要求される場合は、認証または前述メンションアクセス許可なしで使用できます。

"List GitHub Actions caches for a repository" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
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.

クエリ パラメーター
名前, Type, 説明
per_page integer

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

Default: 30

page integer

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

Default: 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.

Default: last_accessed_at

次のいずれかにできます: created_at, last_accessed_at, size_in_bytes

direction string

The direction to sort the results by.

Default: desc

次のいずれかにできます: asc, desc

"List GitHub Actions caches for a repository" の HTTP 応答状態コード

状態コード説明
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>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/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)

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.

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

"Delete GitHub Actions caches for a repository (using a cache key)" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンには次のアクセス許可が設定されている必要があります:

  • "Actions" repository permissions (write)

"Delete GitHub Actions caches for a repository (using a cache key)" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
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.

クエリ パラメーター
名前, Type, 説明
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.

"Delete GitHub Actions caches for a repository (using a cache key)" の HTTP 応答状態コード

状態コード説明
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>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ "https://api.github.com/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)

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

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

"Delete a GitHub Actions cache for a repository (using a cache ID)" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンには次のアクセス許可が設定されている必要があります:

  • "Actions" repository permissions (write)

"Delete a GitHub Actions cache for a repository (using a cache ID)" のパラメーター

ヘッダー
名前, Type, 説明
accept string

Setting to application/vnd.github+json is recommended.

パス パラメーター
名前, Type, 説明
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.

"Delete a GitHub Actions cache for a repository (using a cache ID)" の HTTP 応答状態コード

状態コード説明
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>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/actions/caches/CACHE_ID

Response

Status: 204