Get GitHub Actions cache retention limit for an enterprise

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 "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

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

{
  "max_cache_retention_days": 80
}

Request

Response

Errors