List self-hosted runner groups for an enterprise

Lists all self-hosted runner groups for an enterprise. You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.

GET/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.

Query Parameters

per_page integer optional: Results per page (max 100)
page integer optional: Page number of the results to fetch.

Responses

application/json object

Response

runner_groups array[runner-groups-enterprise object]

required

items runner-groups-enterprise object

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

total_count number

required

Response Example: 200 application/json

{
  "runner_groups": [
    {
      "allows_public_repositories": false,
      "default": true,
      "id": 1,
      "name": "Default",
      "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners",
      "visibility": "all"
    },
    {
      "allows_public_repositories": true,
      "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"
    },
    {
      "allows_public_repositories": true,
      "default": false,
      "id": 3,
      "name": "expensive-hardware",
      "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners",
      "visibility": "private"
    }
  ],
  "total_count": 3
}

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.

per_page

Results per page (max 100)

page

Page number of the results to fetch.

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runner-groups