Puntos de conexión de API de REST para la caché de Acciones de GitHub

Acerca de la memoria caché en GitHub Actions

Puedes usar la API REST para consultar y administrar la memoria caché de repositorios en GitHub Actions. También puedes instalar una extensión de GitHub CLI para administrar las memorias caché desde la línea de comandos. Para obtener más información, vea «Almacenar en caché las dependencias para agilizar los flujos de trabajo».

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.

Parámetros para "Get GitHub Actions cache usage for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Códigos de estado de respuesta HTTP para "Get GitHub Actions cache usage for an enterprise"

status code	Descripción
`200`	OK

Ejemplos de código para "Get GitHub Actions cache usage for an enterprise"

Ejemplo de solicitud

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.

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

Parámetros para "Get GitHub Actions cache usage policy for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Códigos de estado de respuesta HTTP para "Get GitHub Actions cache usage policy for an enterprise"

status code	Descripción
`200`	OK

Ejemplos de código para "Get GitHub Actions cache usage policy for an enterprise"

Ejemplo de solicitud

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.

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

Parámetros para "Set GitHub Actions cache usage policy for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`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 estado de respuesta HTTP para "Set GitHub Actions cache usage policy for an enterprise"

status code	Descripción
`204`	No Content

Ejemplos de código para "Set GitHub Actions cache usage policy for an enterprise"

Ejemplo de solicitud

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

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.

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

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.

Códigos de estado de respuesta HTTP para "Get GitHub Actions cache usage for an organization"

status code	Descripción
`200`	OK

Ejemplos de código para "Get GitHub Actions cache usage for an organization"

Ejemplo de solicitud

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

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.

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

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List repositories with GitHub Actions cache usage for an organization"

status code	Descripción
`200`	OK

Ejemplos de código para "List repositories with GitHub Actions cache usage for an organization"

Ejemplo de solicitud

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

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.

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

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.

Códigos de estado de respuesta HTTP para "Get GitHub Actions cache usage for a repository"

status code	Descripción
`200`	OK

Ejemplos de código para "Get GitHub Actions cache usage for a repository"

Ejemplo de solicitud

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

Gets GitHub Actions cache usage policy for a repository.

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

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

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.

Códigos de estado de respuesta HTTP para "Get GitHub Actions cache usage policy for a repository"

status code	Descripción
`200`	OK

Ejemplos de código para "Get GitHub Actions cache usage policy for a repository"

Ejemplo de solicitud

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

Sets GitHub Actions cache usage policy for a repository.

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

Parámetros para "Set GitHub Actions cache usage policy for a repository"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`repo_cache_size_limit_in_gb` integer Requerido The size limit for the sum of all caches, in gigabytes.

Códigos de estado de respuesta HTTP para "Set GitHub Actions cache usage policy for a repository"

status code	Descripción
`204`	No Content

Ejemplos de código para "Set GitHub Actions cache usage policy for a repository"

Ejemplo de solicitud

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

Lists the GitHub Actions caches for a repository.

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

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

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `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. Valor predeterminado: `last_accessed_at` Puede ser uno de los siguientes: `created_at`, `last_accessed_at`, `size_in_bytes`
`direction` string The direction to sort the results by. Valor predeterminado: `desc` Puede ser uno de los siguientes: `asc`, `desc`

Códigos de estado de respuesta HTTP para "List GitHub Actions caches for a repository"

status code	Descripción
`200`	OK

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

Ejemplo de solicitud

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)

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.

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

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`key` string Requerido 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 estado de respuesta HTTP para "Delete GitHub Actions caches for a repository (using a cache key)"

status code	Descripción
`200`	OK

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

Ejemplo de solicitud

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)

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.

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

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. The name is not case sensitive.
`cache_id` integer Requerido The unique identifier of the GitHub Actions cache.

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

status code	Descripción
`204`	No Content

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

Ejemplo de solicitud

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