Caché de Acciones de GitHub - GitHub Enterprise Server 3.6 Docs

Usa la API REST para interactuar con la memoria caché de los repositorios en GitHub Actions.

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, consulta "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. 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"

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"

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. 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"

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"

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. 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"

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"

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

Funciona con GitHub Apps

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"

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"

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

Funciona con GitHub Apps

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"

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). Valor predeterminado: `30`
`page` integer Page number of the results to fetch. 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"

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

Funciona con GitHub Apps

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"

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"

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

Funciona con GitHub Apps

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"

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"

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

Funciona con GitHub Apps

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"

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"

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