GET/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention

Get artifact and log retention settings for a repository

Gets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for a repository.

Checks include check suites, check runs, and check annotations. These settings also apply to checks and commit statuses created by third-party integrations, and are not limited to data created by GitHub Actions.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

2 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

2 status codes

200Response

daysintegerrequired

The number of days checks, workflow runs, commit statuses, artifacts, and logs are retained

maximum_allowed_daysintegerrequired

The maximum number of days that can be configured

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

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

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

const result = await client.artifactAndLogRetention.list({
  owner: "octocat",
  repo: "hello-world",
});

{
  "days": 90,
  "maximum_allowed_days": 365
}

Request

Response

Errors