Set default workflow permissions for a repository

PUT

/repos/{owner}/{repo}/actions/permissions/workflow

actions

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions
can submit approving pull request reviews.
For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/repos///actions/permissions/workflow' \
--header 'Content-Type: application/json' \
--data-raw '{
    "can_approve_pull_request_reviews": true,
    "default_workflow_permissions": "read"
}'

Response Example

204 - Example 1

{}

Request

Path Params

owner

string

required

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

repo

string

required

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

Body Params application/json

can_approve_pull_request_reviews

boolean

optional

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

default_workflow_permissions

enum<string>

optional

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

Allowed values:

readwrite

Examples

Responses

🟢204Success response

application/json

Body

object {0}

🟠409Conflict response when changing a setting is prevented by the owning organization

Modified at 2023-08-15 02:59:24

Get default workflow permissions for a repository

List workflow runs for a required workflow