Search
K
GitHub v3 REST API

Enable a selected repository for GitHub Actions in an organization

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

put
http://HOSTNAME/api/v3/orgs/{org}/actions/permissions/repositories/{repository_id}

Path Parameters

orgstringrequired
repository_idintegerrequired

Response

204

Response

put/orgs/{org}/actions/permissions/repositories/{repository_id}
 
204

Disable a selected repository for GitHub Actions in an organization

Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

delete
http://HOSTNAME/api/v3/orgs/{org}/actions/permissions/repositories/{repository_id}

Path Parameters

orgstringrequired
repository_idintegerrequired

Response

204

Response

delete/orgs/{org}/actions/permissions/repositories/{repository_id}
 
204

Get allowed actions for an organization

Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see “Set GitHub Actions permissions for an organization.”"

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

get
http://HOSTNAME/api/v3/orgs/{org}/actions/permissions/selected-actions

Path Parameters

orgstringrequired

Response

200 application/json

Response

selected-actions

github_owned_allowedbooleanrequired

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

patterns_allowedarray[string]required

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

get/orgs/{org}/actions/permissions/selected-actions
 
200 application/json

Set allowed actions for an organization

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

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise’s allowed actions settings.

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

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

put
http://HOSTNAME/api/v3/orgs/{org}/actions/permissions/selected-actions

Path Parameters

orgstringrequired

Body

application/json

selected-actions

github_owned_allowedbooleanrequired

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

patterns_allowedarray[string]required

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

Response

204

Response

put/orgs/{org}/actions/permissions/selected-actions

Body

{ "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] }
 
204

List self-hosted runner groups for an organization

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
You must authenticate using an access token with the admin:org scope to use this endpoint.

get
http://HOSTNAME/api/v3/orgs/{org}/actions/runner-groups

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

orgstringrequired

Response

200 application/json

Response

total_countnumberrequired
runner_groupsarray[object]required
Show Child Parameters
get/orgs/{org}/actions/runner-groups
 
200 application/json