Get default workflow permissions for a repository
GET
/repos/{owner}/{repo}/actions/permissions/workflow
Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,
as well as if GitHub Actions can submit approving pull request reviews.
For more information, see “Setting the permissions of the GITHUB_TOKEN for your repository.”
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ” owner
required
string
The account owner of the repository. The name is not case sensitive.
repo
required
string
The name of the repository without the .git extension. The name is not case sensitive.
Responses
Section titled “ Responses ”Response
Media type application/json
object
default_workflow_permissions
required
The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
string
can_approve_pull_request_reviews
required
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
boolean
Examples
Example default
Give read-only permission, and allow approving PRs.
{ "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true}