Cache GitHub Actions

Utilisez l’API REST pour interagir avec le cache des référentiels dans GitHub Actions.

À propos du cache dans GitHub Actions

Vous pouvez utiliser l’API REST pour interroger et gérer le cache des référentiels dans GitHub Actions. Vous pouvez également installer une extension GitHub CLI pour gérer vos caches à partir de la ligne de commande. Pour plus d’informations, consultez « Caching dependencies to speed up workflows ».

Get GitHub Actions cache usage for an enterprise

Compatible avec GitHub Apps

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.

Paramètres pour « Get GitHub Actions cache usage for an enterprise »

En-têtes
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`enterprise`stringObligatoire The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Codes d’état de la réponse HTTP pour « Get GitHub Actions cache usage for an enterprise »

Code d’état	Description
`200`	OK

Exemples de code pour « 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

Compatible avec GitHub Apps

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.

Paramètres pour « Get GitHub Actions cache usage policy for an enterprise »

En-têtes
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`enterprise`stringObligatoire The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Codes d’état de la réponse HTTP pour « Get GitHub Actions cache usage policy for an enterprise »

Code d’état	Description
`200`	OK

Exemples de code pour « 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

Compatible avec GitHub Apps

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.

Paramètres pour « Set GitHub Actions cache usage policy for an enterprise »

En-têtes
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`enterprise`stringObligatoire The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Paramètres du corps
Nom, Type, Description
`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.

Codes d’état de la réponse HTTP pour « Set GitHub Actions cache usage policy for an enterprise »

Code d’état	Description
`204`	No Content

Exemples de code pour « 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

Compatible avec 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.

Paramètres pour « Get GitHub Actions cache usage for an organization »

En-têtes
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`org`stringObligatoire The organization name. The name is not case sensitive.

Codes d’état de la réponse HTTP pour « Get GitHub Actions cache usage for an organization »

Code d’état	Description
`200`	OK

Exemples de code pour « 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

Compatible avec 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.

Paramètres pour « List repositories with GitHub Actions cache usage for an organization »

En-têtes
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`org`stringObligatoire The organization name. The name is not case sensitive.
Paramètres de requête
Nom, Type, Description
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

Codes d’état de la réponse HTTP pour « List repositories with GitHub Actions cache usage for an organization »

Code d’état	Description
`200`	OK

Exemples de code pour « 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

Compatible avec 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.

Paramètres pour « Get GitHub Actions cache usage for a repository »

En-têtes
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`owner`stringObligatoire The account owner of the repository. The name is not case sensitive.
`repo`stringObligatoire The name of the repository. The name is not case sensitive.

Codes d’état de la réponse HTTP pour « Get GitHub Actions cache usage for a repository »

Code d’état	Description
`200`	OK

Exemples de code pour « 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

Compatible avec 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.

Paramètres pour « Get GitHub Actions cache usage policy for a repository »

En-têtes
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`owner`stringObligatoire The account owner of the repository. The name is not case sensitive.
`repo`stringObligatoire The name of the repository. The name is not case sensitive.

Codes d’état de la réponse HTTP pour « Get GitHub Actions cache usage policy for a repository »

Code d’état	Description
`200`	OK

Exemples de code pour « 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

Compatible avec 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.

Paramètres pour « Set GitHub Actions cache usage policy for a repository »

En-têtes
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`owner`stringObligatoire The account owner of the repository. The name is not case sensitive.
`repo`stringObligatoire The name of the repository. The name is not case sensitive.
Paramètres du corps
Nom, Type, Description
`repo_cache_size_limit_in_gb`integerObligatoire The size limit for the sum of all caches, in gigabytes.

Codes d’état de la réponse HTTP pour « Set GitHub Actions cache usage policy for a repository »

Code d’état	Description
`204`	No Content

Exemples de code pour « 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