Skip to content
forgit api docs

List self-hosted runners in a group for an organization

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

Lists self-hosted runners that are in a specific organization group.

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.

runner_group_id
required
integer

Unique identifier of the self-hosted runner group.

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

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
object
total_count
required
number
runners
required
Array<object>
Self hosted runners

A self hosted runner

object
id
required

The ID of the runner.

integer
runner_group_id

The ID of the runner group.

integer
name
required

The name of the runner.

string
os
required

The Operating System of the runner.

string
status
required

The status of the runner.

string
busy
required
boolean
labels
required
Array<object>
Self hosted runner label

A label for a self hosted runner

object
id

Unique identifier of the label.

integer
name
required

Name of the label.

string
type

The type of label. Read-only labels are applied automatically when the runner is configured.

string
Allowed values: read-only custom
ephemeral
boolean
version

The version of the GitHub Actions Runner software. This is only set if the runner has connected to the service at least once.

string
nullable
Examples
Example default 
{
  "total_count": 2,
  "runners": [
    {
      "id": 23,
      "name": "linux_runner",
      "os": "linux",
      "status": "online",
      "busy": true,
      "ephemeral": false,
      "version": "2.323.0",
      "labels": [
        {
          "id": 5,
          "name": "self-hosted",
          "type": "read-only"
        },
        {
          "id": 7,
          "name": "X64",
          "type": "read-only"
        },
        {
          "id": 11,
          "name": "Linux",
          "type": "read-only"
        }
      ]
    },
    {
      "id": 24,
      "name": "mac_runner",
      "os": "macos",
      "status": "offline",
      "busy": false,
      "ephemeral": false,
      "version": "2.323.0",
      "labels": [
        {
          "id": 5,
          "name": "self-hosted",
          "type": "read-only"
        },
        {
          "id": 7,
          "name": "X64",
          "type": "read-only"
        },
        {
          "id": 20,
          "name": "macOS",
          "type": "read-only"
        },
        {
          "id": 21,
          "name": "no-gpu",
          "type": "custom"
        }
      ]
    }
  ]
}

Headers

Section titled “ Headers ”
Link
string
Example 
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"