GET/enterprises/{enterprise}/actions/cache/retention-limit

Get GitHub Actions cache retention limit for an enterprise

Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this enterprise may not set a higher cache retention limit.

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

[!NOTE] The "Enterprise administration" fine-grained permission is not available to callers. To use this API, you must use an OAuth app token or a personal access token (classic).

1 parameter

enterprisestringrequired

The slug version of the enterprise name.

3 status codes

200Response

max_cache_retention_daysintegeroptional

For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.retentionLimit.list({ enterprise: "example" });

{
  "max_cache_retention_days": 80
}

Request

Response

Errors