Skip to content
forgit api docs

List self-hosted runner groups for an organization

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

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

Query Parameters

Section titled “ Query Parameters ”
per_page
integer
default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page
integer
default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

visible_to_repository
string

Only return runner groups that are allowed to be used by this repository.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
object
total_count
required
number
runner_groups
required
Array<object>
object
id
required
number
name
required
string
visibility
required
string
default
required
boolean
selected_repositories_url

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

string
runners_url
required
string
hosted_runners_url
string
network_configuration_id

The identifier of a hosted compute network configuration.

string
inherited
required
boolean
inherited_allows_public_repositories
boolean
allows_public_repositories
required
boolean
workflow_restrictions_read_only

If true, the restricted_to_workflows and selected_workflows fields cannot be modified.

boolean
restricted_to_workflows

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

boolean
selected_workflows

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

Array<string>
Examples
Example default 
{
  "total_count": 3,
  "runner_groups": [
    {
      "id": 1,
      "name": "Default",
      "visibility": "all",
      "default": true,
      "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners",
      "inherited": false,
      "allows_public_repositories": true,
      "restricted_to_workflows": false,
      "selected_workflows": [],
      "workflow_restrictions_read_only": false
    },
    {
      "id": 2,
      "name": "octo-runner-group",
      "visibility": "selected",
      "default": false,
      "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories",
      "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
      "inherited": true,
      "allows_public_repositories": true,
      "restricted_to_workflows": true,
      "selected_workflows": [
        "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
      ],
      "workflow_restrictions_read_only": true
    },
    {
      "id": 3,
      "name": "expensive-hardware",
      "visibility": "private",
      "default": false,
      "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners",
      "inherited": false,
      "allows_public_repositories": true,
      "restricted_to_workflows": false,
      "selected_workflows": [
        "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
      ],
      "workflow_restrictions_read_only": false
    }
  ]
}