Create a self-hosted runner group for an enterprise

Creates a new self-hosted runner group for an enterprise. You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.

POST/enterprises/{enterprise}/actions/runner-groups

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

enterprise string required: The slug version of the enterprise name. You can also substitute this value with the enterprise id.

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_organization_ids array[integer]

optional

List of organization IDs that can access the runner group.

visibility string

optional

Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`

Allowed: "selected""all"

Responses

application/json runner-groups-enterprise object

Response

allows_public_repositories boolean

required

default boolean

required

id number

required

name string

required

runners_url string

required

selected_organizations_url string

optional

visibility string

required

Response Example: 201 application/json

{
  "allows_public_repositories": false,
  "default": false,
  "id": 2,
  "name": "octo-runner-group",
  "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners",
  "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations",
  "visibility": "selected"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

enterprise *

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Request Sample: Shell / cURL

curl --request POST \
  --url {protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runner-groups \
  --header 'content-type: application/json' \
  --data '{
  "name": "Expensive hardware runners",
  "runners": [
    9,
    2
  ],
  "selected_organization_ids": [
    32,
    91
  ],
  "visibility": "selected"
}'