Skip to main content
Manja / GitHub

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](https://docs.github.com/github/getting-started-with-github/githubs-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.

POST/orgs/{org}/actions/runner-groups
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
org string
required
Body Params
required
application/jsonobject
allows_public_repositories boolean
optional

Whether the runner group can be used by `public` repositories.

Default: false

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

Default: all

Allowed: "selected""all""private"

Responses

application/json runner-groups-org object

Response

allows_public_repositories boolean
required
default boolean
required
id 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