Skip to content
forgit api docs

Get GitHub Actions cache retention limit for an organization

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

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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Actions cache retention limit for an organization

GitHub Actions cache retention policy for an organization.

object
max_cache_retention_days

For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.

integer
Examples
Example default 
{
  "max_cache_retention_days": 80
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}