Sign in

v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-07-147873273.9 MB
actions

Create a self-hosted runner group for an organization

Creates a new self-hosted runner group for an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.

post/orgs/{org}/actions/runner-groups

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Request body

namestring required

Name of the runner group.

visibility'selected' | 'all' | 'private'

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

selected_repository_idsinteger[]

List of repository IDs that can access the runner group.

runnersinteger[]

List of runner IDs to add to the runner group.

allows_public_repositoriesboolean

Whether the runner group can be used by public repositories.

restricted_to_workflowsboolean

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

selected_workflowsstring[]

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

Example request

{
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
  ]
}

Response

Response

idnumber required
namestring required
visibilitystring required
defaultboolean required
selected_repositories_urlstring

Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected

runners_urlstring required
inheritedboolean required
inherited_allows_public_repositoriesboolean
allows_public_repositoriesboolean required
workflow_restrictions_read_onlyboolean

If true, the restricted_to_workflows and selected_workflows fields cannot be modified.

restricted_to_workflowsboolean

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

selected_workflowsstring[]

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

Example response

{
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
  ]
}