GitHub Actions-Cache
Verwende die REST-API, um für Repositorys in GitHub Actions mit dem Cache zu interagieren.
Informationen zum Cache in GitHub Actions
Du kannst die REST-API verwenden, um den Cache für Repositorys in GitHub Actions abzufragen und zu verwalten. Du kannst auch eine GitHub CLI-Erweiterung installieren, um deine Caches über die Befehlszeile zu verwalten. Weitere Informationen findest du unter Zwischenspeichern von Abhängigkeiten zum Beschleunigen von 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.
Parameters
Headers |
---|
Name, Type, BESCHREIBUNG |
accept stringSetting to |
Path parameters |
Name, Type, BESCHREIBUNG |
enterprise stringRequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
HTTP response status codes
Status code | BESCHREIBUNG |
---|---|
200 | OK |
Code samples
curl \
-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.
GitHub Apps must have the enterprise_administration:write
permission to use this endpoint.
Parameters
Headers |
---|
Name, Type, BESCHREIBUNG |
accept stringSetting to |
Path parameters |
Name, Type, BESCHREIBUNG |
enterprise stringRequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
HTTP response status codes
Status code | BESCHREIBUNG |
---|---|
200 | OK |
Code samples
curl \
-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.
GitHub Apps must have the enterprise_administration:write
permission to use this endpoint.
Parameters
Headers |
---|
Name, Type, BESCHREIBUNG |
accept stringSetting to |
Path parameters |
Name, Type, BESCHREIBUNG |
enterprise stringRequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Body parameters |
Name, Type, BESCHREIBUNG |
repo_cache_size_limit_in_gb integerFor 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 integerFor 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. |
HTTP response status codes
Status code | BESCHREIBUNG |
---|---|
204 | No Content |
Code samples
curl \
-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.
Parameters
Headers |
---|
Name, Type, BESCHREIBUNG |
accept stringSetting to |
Path parameters |
Name, Type, BESCHREIBUNG |
org stringRequiredThe organization name. The name is not case sensitive. |
HTTP response status codes
Status code | BESCHREIBUNG |
---|---|
200 | OK |
Code samples
curl \
-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.
Parameters
Headers |
---|
Name, Type, BESCHREIBUNG |
accept stringSetting to |
Path parameters |
Name, Type, BESCHREIBUNG |
org stringRequiredThe organization name. The name is not case sensitive. |
Query parameters |
Name, Type, BESCHREIBUNG |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
HTTP response status codes
Status code | BESCHREIBUNG |
---|---|
200 | OK |
Code samples
curl \
-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.
Parameters
Headers |
---|
Name, Type, BESCHREIBUNG |
accept stringSetting to |
Path parameters |
Name, Type, BESCHREIBUNG |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
HTTP response status codes
Status code | BESCHREIBUNG |
---|---|
200 | OK |
Code samples
curl \
-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.
Parameters
Headers |
---|
Name, Type, BESCHREIBUNG |
accept stringSetting to |
Path parameters |
Name, Type, BESCHREIBUNG |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
HTTP response status codes
Status code | BESCHREIBUNG |
---|---|
200 | OK |
Code samples
curl \
-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.
Parameters
Headers |
---|
Name, Type, BESCHREIBUNG |
accept stringSetting to |
Path parameters |
Name, Type, BESCHREIBUNG |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
Body parameters |
Name, Type, BESCHREIBUNG |
repo_cache_size_limit_in_gb integerRequiredThe size limit for the sum of all caches, in gigabytes. |
HTTP response status codes
Status code | BESCHREIBUNG |
---|---|
204 | No Content |
Code samples
curl \
-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