Cache do GitHub Actions
Use a API REST para interagir com o cache dos repositórios no GitHub Actions.
Sobre o cache no GitHub Actions
Use a API REST para consultar e gerenciar o cache dos repositórios no GitHub Actions. Você também pode instalar uma extensão do GitHub CLI para gerenciar seus caches da linha de comando. Para obter mais informações, confira "Armazenar dependências em cache para acelerar fluxos de trabalho."
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
enterprise stringRequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
Code samples
curl \
-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.
GitHub Apps must have the enterprise_administration:write
permission to use this endpoint.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
enterprise stringRequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
Code samples
curl \
-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.
GitHub Apps must have the enterprise_administration:write
permission to use this endpoint.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
enterprise stringRequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Body parameters |
Nome, Type, Descrição |
repo_cache_size_limit_in_gb integerFor 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 integerFor 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 response status codes
Status code | Descrição |
---|---|
204 | No Content |
Code samples
curl \
-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
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
org stringRequiredThe organization name. The name is not case sensitive. |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
Code samples
curl \
-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
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
org stringRequiredThe organization name. The name is not case sensitive. |
Query parameters |
Nome, Type, Descrição |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
Code samples
curl \
-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
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
Code samples
curl \
-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
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
Code samples
curl \
-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
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
Body parameters |
Nome, Type, Descrição |
repo_cache_size_limit_in_gb integerRequiredThe size limit for the sum of all caches, in gigabytes. |
HTTP response status codes
Status code | Descrição |
---|---|
204 | No Content |
Code samples
curl \
-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
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
Query parameters |
Nome, Type, Descrição |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
ref stringThe Git reference for the results you want to list. The |
key stringAn explicit key or prefix for identifying the cache |
sort stringThe property to sort the results by. Default: Can be one of: |
direction stringThe direction to sort the results by. Default: Can be one of: |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
Code samples
curl \
-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)
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
Query parameters |
Nome, Type, Descrição |
key stringRequiredA key for identifying the cache. |
ref stringThe Git reference for the results you want to list. The |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
Code samples
curl \
-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)
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.
Parameters
Headers |
---|
Nome, Type, Descrição |
accept stringSetting to |
Path parameters |
Nome, Type, Descrição |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
cache_id integerRequiredThe unique identifier of the GitHub Actions cache. |
HTTP response status codes
Status code | Descrição |
---|---|
204 | No Content |
Code samples
curl \
-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