Get GitHub Actions permissions for a repository

GET

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

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///actions/permissions'

Response Example

{
    "allowed_actions": "all",
    "enabled": true,
    "selected_actions_url": "string"
}

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

allowed_actions

enum<string>

optional

The permissions policy that controls the actions and reusable workflows that are allowed to run.

Allowed values:

alllocal_onlyselected

enabled

boolean

required

Whether GitHub Actions is enabled on the repository.

selected_actions_url

string

optional

The API URL to use to get or set the actions and reusable workflows that are allowed to run, when allowed_actions is set to selected.

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

Set the customization template for an OIDC subject claim for a repository

Set GitHub Actions permissions for a repository