Get a self-hosted runner group for an organization

Gets a specific self-hosted runner group for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint.

GET/orgs/{org}/actions/runner-groups/{runner_group_id}

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

Request

Path Parameters

org string required
runner_group_id integer required: Unique identifier of the self-hosted runner group.

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

Response Example: 200 application/json

{
  "allows_public_repositories": true,
  "default": false,
  "id": 2,
  "inherited": false,
  "name": "octo-runner-group",
  "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
  "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories",
  "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

org *

runner_group_id *

Unique identifier of the self-hosted runner group.

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/orgs/{org}/actions/runner-groups/{runner_group_id}