Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 2.33 KB

setAllowedActionsRepository.md

File metadata and controls

64 lines (47 loc) · 2.33 KB
name example route scope type
Set allowed actions for a repository
octokit.actions.setAllowedActionsRepository({ owner, repo, github_owned_allowed, verified_allowed, patterns_allowed })
PUT /repos/{owner}/{repo}/actions/permissions/selected-actions
actions
API method

Set allowed actions for a repository

Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for a repository."

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

octokit.actions.setAllowedActionsRepository({
  owner,
  repo,
  github_owned_allowed,
  verified_allowed,
  patterns_allowed,
});

Parameters

name required description
owneryes
repoyes
github_owned_allowedyes

Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

verified_allowedyes

Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

patterns_allowedyes

Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*."

See also: GitHub Developer Guide documentation.