Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/actions/getActionsCacheRetentionLimitForEnterprise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Get GitHub Actions cache retention limit for an enterprise
example: octokit.rest.actions.getActionsCacheRetentionLimitForEnterprise({ enterprise })
route: GET /enterprises/{enterprise}/actions/cache/retention-limit
scope: actions
type: API method
---

# 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.

```js
octokit.rest.actions.getActionsCacheRetentionLimitForEnterprise({
enterprise,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>enterprise</td><td>yes</td><td>

The slug version of the enterprise name.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise).
41 changes: 41 additions & 0 deletions docs/actions/getActionsCacheRetentionLimitForOrganization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Get GitHub Actions cache retention limit for an organization
example: octokit.rest.actions.getActionsCacheRetentionLimitForOrganization({ org })
route: GET /organizations/{org}/actions/cache/retention-limit
scope: actions
type: API method
---

# Get GitHub Actions cache retention limit for an organization

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.

```js
octokit.rest.actions.getActionsCacheRetentionLimitForOrganization({
org,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization).
47 changes: 47 additions & 0 deletions docs/actions/getActionsCacheRetentionLimitForRepository.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Get GitHub Actions cache retention limit for a repository
example: octokit.rest.actions.getActionsCacheRetentionLimitForRepository({ owner, repo })
route: GET /repos/{owner}/{repo}/actions/cache/retention-limit
scope: actions
type: API method
---

# Get GitHub Actions cache retention limit for a repository

Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if
not manually removed or evicted due to size constraints.

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

```js
octokit.rest.actions.getActionsCacheRetentionLimitForRepository({
owner,
repo,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>owner</td><td>yes</td><td>

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

</td></tr>
<tr><td>repo</td><td>yes</td><td>

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

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository).
41 changes: 41 additions & 0 deletions docs/actions/getActionsCacheStorageLimitForEnterprise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Get GitHub Actions cache storage limit for an enterprise
example: octokit.rest.actions.getActionsCacheStorageLimitForEnterprise({ enterprise })
route: GET /enterprises/{enterprise}/actions/cache/storage-limit
scope: actions
type: API method
---

# Get GitHub Actions cache storage limit for an enterprise

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

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

```js
octokit.rest.actions.getActionsCacheStorageLimitForEnterprise({
enterprise,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>enterprise</td><td>yes</td><td>

The slug version of the enterprise name.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise).
41 changes: 41 additions & 0 deletions docs/actions/getActionsCacheStorageLimitForOrganization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Get GitHub Actions cache storage limit for an organization
example: octokit.rest.actions.getActionsCacheStorageLimitForOrganization({ org })
route: GET /organizations/{org}/actions/cache/storage-limit
scope: actions
type: API method
---

# Get GitHub Actions cache storage limit for an organization

Gets GitHub Actions cache storage limit for an organization. All repositories under this
organization may not set a higher cache storage limit.

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

```js
octokit.rest.actions.getActionsCacheStorageLimitForOrganization({
org,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization).
47 changes: 47 additions & 0 deletions docs/actions/getActionsCacheStorageLimitForRepository.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Get GitHub Actions cache storage limit for a repository
example: octokit.rest.actions.getActionsCacheStorageLimitForRepository({ owner, repo })
route: GET /repos/{owner}/{repo}/actions/cache/storage-limit
scope: actions
type: API method
---

# Get GitHub Actions cache storage limit for a repository

Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be
stored before eviction occurs.

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

```js
octokit.rest.actions.getActionsCacheStorageLimitForRepository({
owner,
repo,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>owner</td><td>yes</td><td>

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

</td></tr>
<tr><td>repo</td><td>yes</td><td>

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

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository).
46 changes: 46 additions & 0 deletions docs/actions/setActionsCacheRetentionLimitForEnterprise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Set GitHub Actions cache retention limit for an enterprise
example: octokit.rest.actions.setActionsCacheRetentionLimitForEnterprise({ enterprise })
route: PUT /enterprises/{enterprise}/actions/cache/retention-limit
scope: actions
type: API method
---

# Set GitHub Actions cache retention limit for an enterprise

Sets 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.

```js
octokit.rest.actions.setActionsCacheRetentionLimitForEnterprise({
enterprise,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>enterprise</td><td>yes</td><td>

The slug version of the enterprise name.

</td></tr>
<tr><td>max_cache_retention_days</td><td>no</td><td>

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

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise).
46 changes: 46 additions & 0 deletions docs/actions/setActionsCacheRetentionLimitForOrganization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Set GitHub Actions cache retention limit for an organization
example: octokit.rest.actions.setActionsCacheRetentionLimitForOrganization({ org })
route: PUT /organizations/{org}/actions/cache/retention-limit
scope: actions
type: API method
---

# Set GitHub Actions cache retention limit for an organization

Sets 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.

```js
octokit.rest.actions.setActionsCacheRetentionLimitForOrganization({
org,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
<tr><td>max_cache_retention_days</td><td>no</td><td>

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

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization).
Loading
Loading