PUT/orgs/{org}/actions/permissions/artifact-and-log-retention

Set artifact and log retention settings for an organization

Sets retention settings for checks, workflow runs, commit statuses, artifacts, and logs for an organization.

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 admin:org scope or the "Actions policies" fine-grained permission to use this endpoint.

1 parameter · 1 body field

orgstringrequired

The organization name. The name is not case sensitive.

daysintegerrequired

The number of days to retain checks, workflow runs, commit statuses, artifacts, and logs

5 status codes

204No content

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

409Conflict

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<object>optional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 409 is returned: Conflict. A 422 is returned: Validation failed, or the endpoint has been spammed.

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

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

const result = await client.artifactAndLogRetention.update({
  org: "acme-inc",
  days: 20,
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors