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 "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.
Parâmetros para "Get GitHub Actions cache usage for an enterprise"
Cabeçalhos |
---|
Nome, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Nome, Tipo, Descrição |
enterprise string ObrigatórioThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Códigos de status de resposta HTTP para "Get GitHub Actions cache usage for an enterprise"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get GitHub Actions cache usage for an enterprise"
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.
Parâmetros para "Get GitHub Actions cache usage policy for an enterprise"
Cabeçalhos |
---|
Nome, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Nome, Tipo, Descrição |
enterprise string ObrigatórioThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Códigos de status de resposta HTTP para "Get GitHub Actions cache usage policy for an enterprise"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get GitHub Actions cache usage policy for an enterprise"
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.
Parâmetros para "Set GitHub Actions cache usage policy for an enterprise"
Cabeçalhos |
---|
Nome, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Nome, Tipo, Descrição |
enterprise string ObrigatórioThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Parâmetros do corpo |
Nome, Tipo, Descrição |
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. |
Códigos de status de resposta HTTP para "Set GitHub Actions cache usage policy for an enterprise"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "Set GitHub Actions cache usage policy for an enterprise"
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
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.
Parâmetros para "Get GitHub Actions cache usage for an organization"
Cabeçalhos |
---|
Nome, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Nome, Tipo, Descrição |
org string ObrigatórioThe organization name. The name is not case sensitive. |
Códigos de status de resposta HTTP para "Get GitHub Actions cache usage for an organization"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get GitHub Actions cache usage for an organization"
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
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.
Parâmetros para "List repositories with GitHub Actions cache usage for an organization"
Cabeçalhos |
---|
Nome, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Nome, Tipo, Descrição |
org string ObrigatórioThe organization name. The name is not case sensitive. |
Parâmetros de consulta |
Nome, Tipo, Descrição |
per_page integer The number of results per page (max 100). Padrão: |
page integer Page number of the results to fetch. Padrão: |
Códigos de status de resposta HTTP para "List repositories with GitHub Actions cache usage for an organization"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "List repositories with GitHub Actions cache usage for an organization"
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
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.
Parâmetros para "Get GitHub Actions cache usage for a repository"
Cabeçalhos |
---|
Nome, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Nome, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
Códigos de status de resposta HTTP para "Get GitHub Actions cache usage for a repository"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get GitHub Actions cache usage for a repository"
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
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.
Parâmetros para "Get GitHub Actions cache usage policy for a repository"
Cabeçalhos |
---|
Nome, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Nome, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
Códigos de status de resposta HTTP para "Get GitHub Actions cache usage policy for a repository"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get GitHub Actions cache usage policy for a repository"
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
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.
Parâmetros para "Set GitHub Actions cache usage policy for a repository"
Cabeçalhos |
---|
Nome, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Nome, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
Parâmetros do corpo |
Nome, Tipo, Descrição |
repo_cache_size_limit_in_gb integer ObrigatórioThe size limit for the sum of all caches, in gigabytes. |
Códigos de status de resposta HTTP para "Set GitHub Actions cache usage policy for a repository"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "Set GitHub Actions cache usage policy for a repository"
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