Pontos de extremidade da API REST para o cache do GitHub Actions

Get GitHub Actions cache retention limit for an enterprise

Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache retention limit.

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

Tokens de acesso refinados para "Get GitHub Actions cache retention limit for an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "Get GitHub Actions cache retention limit for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.

Códigos de status de resposta HTTP para "Get GitHub Actions cache retention limit for an enterprise"

Código de status	Descrição
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Get GitHub Actions cache retention limit for an enterprise"

Exemplo de solicitação

get/enterprises/{enterprise}/actions/cache/retention-limit

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/retention-limit

Response

Status: 200

{
  "max_cache_retention_days": 80
}

Set GitHub Actions cache retention limit for an enterprise

Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache retention limit.

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

Tokens de acesso refinados para "Set GitHub Actions cache retention limit for an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "Set GitHub Actions cache retention limit for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.

Parâmetros do corpo
Nome, Tipo, Descrição
`max_cache_retention_days` integer For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.

Códigos de status de resposta HTTP para "Set GitHub Actions cache retention limit for an enterprise"

Código de status	Descrição
`204`	No Content
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Set GitHub Actions cache retention limit for an enterprise"

Exemplo de solicitação

put/enterprises/{enterprise}/actions/cache/retention-limit

curl -L \
  -X PUT \
  -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/retention-limit \
  -d '{"max_cache_retention_days":80}'

Response

Status: 204

Get GitHub Actions cache storage limit for an enterprise

Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache storage limit.

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

Tokens de acesso refinados para "Get GitHub Actions cache storage limit for an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "Get GitHub Actions cache storage limit for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.

Códigos de status de resposta HTTP para "Get GitHub Actions cache storage limit for an enterprise"

Código de status	Descrição
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Get GitHub Actions cache storage limit for an enterprise"

Exemplo de solicitação

get/enterprises/{enterprise}/actions/cache/storage-limit

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/storage-limit

Response

Status: 200

{
  "max_cache_size_gb": 150
}

Set GitHub Actions cache storage limit for an enterprise

Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache storage limit.

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

Tokens de acesso refinados para "Set GitHub Actions cache storage limit for an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "Set GitHub Actions cache storage limit for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.

Parâmetros do corpo
Nome, Tipo, Descrição
`max_cache_size_gb` integer For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.

Códigos de status de resposta HTTP para "Set GitHub Actions cache storage limit for an enterprise"

Código de status	Descrição
`204`	No Content
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Set GitHub Actions cache storage limit for an enterprise"

Exemplo de solicitação

put/enterprises/{enterprise}/actions/cache/storage-limit

curl -L \
  -X PUT \
  -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/storage-limit \
  -d '{"max_cache_size_gb":150}'

Response

Status: 204

Get GitHub Actions cache retention limit for an organization

Gets GitHub Actions cache retention limit for an organization. All repositories under this organization may not set a higher cache retention limit.

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

Tokens de acesso refinados para "Get GitHub Actions cache retention limit for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (read)

Parâmetros para "Get GitHub Actions cache retention limit for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP para "Get GitHub Actions cache retention limit for an organization"

Código de status	Descrição
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Get GitHub Actions cache retention limit for an organization"

Exemplo de solicitação

get/organizations/{org}/actions/cache/retention-limit

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/organizations/ORG/actions/cache/retention-limit

Response

Status: 200

{
  "max_cache_retention_days": 80
}

Set GitHub Actions cache retention limit for an organization

Sets GitHub Actions cache retention limit for an organization. All repositories under this organization may not set a higher cache retention limit.

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

Tokens de acesso refinados para "Set GitHub Actions cache retention limit for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Set GitHub Actions cache retention limit for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
`max_cache_retention_days` integer For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.

Códigos de status de resposta HTTP para "Set GitHub Actions cache retention limit for an organization"

Código de status	Descrição
`204`	No Content
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Set GitHub Actions cache retention limit for an organization"

Exemplo de solicitação

put/organizations/{org}/actions/cache/retention-limit

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/organizations/ORG/actions/cache/retention-limit \
  -d '{"max_cache_retention_days":80}'

Response

Status: 204

Get GitHub Actions cache storage limit for an organization

Gets GitHub Actions cache storage limit for an organization. All repositories under this organization may not set a higher cache storage limit.

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

Tokens de acesso refinados para "Get GitHub Actions cache storage limit for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (read)

Parâmetros para "Get GitHub Actions cache storage limit for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP para "Get GitHub Actions cache storage limit for an organization"

Código de status	Descrição
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Get GitHub Actions cache storage limit for an organization"

Exemplo de solicitação

get/organizations/{org}/actions/cache/storage-limit

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/organizations/ORG/actions/cache/storage-limit

Response

Status: 200

{
  "max_cache_size_gb": 150
}

Set GitHub Actions cache storage limit for an organization

Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this organization may not set a higher cache storage limit.

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

Tokens de acesso refinados para "Set GitHub Actions cache storage limit for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Set GitHub Actions cache storage limit for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
`max_cache_size_gb` integer For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.

Códigos de status de resposta HTTP para "Set GitHub Actions cache storage limit for an organization"

Código de status	Descrição
`204`	No Content
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Set GitHub Actions cache storage limit for an organization"

Exemplo de solicitação

put/organizations/{org}/actions/cache/storage-limit

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/organizations/ORG/actions/cache/storage-limit \
  -d '{"max_cache_size_gb":150}'

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.

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

Tokens de acesso refinados para "Get GitHub Actions cache usage for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (read)

Parâmetros para "Get GitHub Actions cache usage for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The 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"

Exemplo de solicitação

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.

Tokens de acesso refinados para "List repositories with GitHub Actions cache usage for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (read)

Parâmetros para "List repositories with GitHub Actions cache usage for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The 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). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`

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"

Exemplo de solicitação

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 retention limit for a repository

Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if not manually removed or evicted due to size constraints.

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

Tokens de acesso refinados para "Get GitHub Actions cache retention limit for a repository"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (read)

Parâmetros para "Get GitHub Actions cache retention limit for a repository"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Códigos de status de resposta HTTP para "Get GitHub Actions cache retention limit for a repository"

Código de status	Descrição
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Get GitHub Actions cache retention limit for a repository"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/cache/retention-limit

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/retention-limit

Response

Status: 200

{
  "max_cache_retention_days": 80
}

Set GitHub Actions cache retention limit for a repository

Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if not manually removed or evicted due to size constraints.

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

Tokens de acesso refinados para "Set GitHub Actions cache retention limit for a repository"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Set GitHub Actions cache retention limit for a repository"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
`max_cache_retention_days` integer The maximum number of days to keep caches in this repository.

Códigos de status de resposta HTTP para "Set GitHub Actions cache retention limit for a repository"

Código de status	Descrição
`204`	No Content
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Set GitHub Actions cache retention limit for a repository"

Exemplo de solicitação

put/repos/{owner}/{repo}/actions/cache/retention-limit

curl -L \
  -X PUT \
  -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/retention-limit \
  -d '{"max_cache_retention_days":80}'

Response

Status: 204

Get GitHub Actions cache storage limit for a repository

Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be stored before eviction occurs.

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

Tokens de acesso refinados para "Get GitHub Actions cache storage limit for a repository"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (read)

Parâmetros para "Get GitHub Actions cache storage limit for a repository"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Códigos de status de resposta HTTP para "Get GitHub Actions cache storage limit for a repository"

Código de status	Descrição
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Get GitHub Actions cache storage limit for a repository"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/cache/storage-limit

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/storage-limit

Response

Status: 200

{
  "max_cache_size_gb": 150
}

Set GitHub Actions cache storage limit for a repository

Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be stored before eviction occurs.

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

Tokens de acesso refinados para "Set GitHub Actions cache storage limit for a repository"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Set GitHub Actions cache storage limit for a repository"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
`max_cache_size_gb` integer The maximum total cache size for this repository, in gigabytes.

Códigos de status de resposta HTTP para "Set GitHub Actions cache storage limit for a repository"

Código de status	Descrição
`204`	No Content
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found

Exemplos de código para "Set GitHub Actions cache storage limit for a repository"

Exemplo de solicitação

put/repos/{owner}/{repo}/actions/cache/storage-limit

curl -L \
  -X PUT \
  -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/storage-limit \
  -d '{"max_cache_size_gb":150}'

Response

Status: 204

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.

Tokens de acesso refinados para "Get GitHub Actions cache usage for a repository"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get GitHub Actions cache usage for a repository"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. 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"

Exemplo de solicitação

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.

Tokens de acesso refinados para "List GitHub Actions caches for a repository"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "List GitHub Actions caches for a repository"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. 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). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `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. Padrão: `last_accessed_at` Pode ser um dos: `created_at`, `last_accessed_at`, `size_in_bytes`
`direction` string The direction to sort the results by. Padrão: `desc` Pode ser um dos: `asc`, `desc`

Códigos de status de resposta HTTP para "List GitHub Actions caches for a repository"

Código de status	Descrição
`200`	OK

Exemplos de código para "List GitHub Actions caches for a repository"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Delete GitHub Actions caches for a repository (using a cache key)"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Delete GitHub Actions caches for a repository (using a cache key)"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`key` string Obrigatório 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`.

Códigos de status de resposta HTTP para "Delete GitHub Actions caches for a repository (using a cache key)"

Código de status	Descrição
`200`	OK

Exemplos de código para "Delete GitHub Actions caches for a repository (using a cache key)"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Delete a GitHub Actions cache for a repository (using a cache ID)"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Delete a GitHub Actions cache for a repository (using a cache ID)"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`cache_id` integer Obrigatório The unique identifier of the GitHub Actions cache.

Códigos de status de resposta HTTP para "Delete a GitHub Actions cache for a repository (using a cache ID)"

Código de status	Descrição
`204`	No Content

Exemplos de código para "Delete a GitHub Actions cache for a repository (using a cache ID)"

Exemplo de solicitação

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