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

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 GET 'https://api.github.com/repos///actions/permissions/workflow'

Response Example

{
    "can_approve_pull_request_reviews": true,
    "default_workflow_permissions": "read"
}

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.

Responses

🟢200Response

application/json

Body

can_approve_pull_request_reviews

boolean

required

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

default_workflow_permissions

enum<string>

required

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

Allowed values:

readwrite

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

Set allowed actions and reusable workflows for a repository

Set default workflow permissions for a repository