Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 1.7 KB

deleteActionsCacheByKey.md

File metadata and controls

59 lines (43 loc) · 1.7 KB
name example route scope type
Delete GitHub Actions caches for a repository (using a cache key)
octokit.rest.actions.deleteActionsCacheByKey({ owner, repo, key })
DELETE /repos/{owner}/{repo}/actions/caches{?key,ref}
actions
API method

Delete GitHub Actions caches for a repository (using a cache key)

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

You must authenticate using an access token with the repo scope to use this endpoint.

GitHub Apps must have the actions:write permission to use this endpoint.

octokit.rest.actions.deleteActionsCacheByKey({
  owner,
  repo,
  key,
});

Parameters

name required description
owneryes

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

repoyes

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

keyyes

A key for identifying the cache.

refno

The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

See also: GitHub Developer Guide documentation.