Create a self-hosted runner group for an organization

The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "GitHub's products."

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.

curl --location --request POST 'https://api.github.com/orgs//actions/runner-groups' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Expensive hardware runners", "runners": [ 9, 2 ], "selected_repository_ids": [ 32, 91 ], "visibility": "selected" }'

{ "allows_public_repositories": true, "default": true, "id": 0, "inherited": true, "inherited_allows_public_repositories": true, "name": "string", "runners_url": "string", "selected_repositories_url": "string", "visibility": "string" }

Request

Path Params

org

string

required

Body Params application/json

name

string

required

Name of the runner group.

runners

array[integer]

optional

List of runner IDs to add to the runner group.

selected_repository_ids

array[integer]

optional

List of repository IDs that can access the runner group.

visibility

enum<string>

optional

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: all, selected, or private.

Allowed values:

selectedallprivate

Default:

all

Examples

Responses

🟢201response

application/json

Body

allows_public_repositories

boolean

required

default

boolean

required

number

required

inherited

boolean

required

inherited_allows_public_repositories

boolean

optional

name

string

required

runners_url

string

required

selected_repositories_url

string

optional

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

visibility

string

required