List self-hosted runners in a group for an enterprise

GET

/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners

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

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/enterprises//actions/runner-groups//runners'

Response Example

{
    "runners": [
        {
            "busy": true,
            "id": 5,
            "labels": [
                {
                    "id": 0,
                    "name": "string",
                    "type": "read-only"
                }
            ],
            "name": "iMac",
            "os": "macos",
            "status": "online"
        }
    ],
    "total_count": 0
}

Request

Path Params

enterprise

string

required

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

runner_group_id

integer

required

Unique identifier of the self-hosted runner group.

Query Params

per_page

integer

optional

Results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200response

application/json

Body

runners

array[object (Self hosted runners) {6}]

required

busy

boolean

required

integer

required

The id of the runner.

Example:

labels

array [object {3}]

required

name

string

required

The name of the runner.

Example:

iMac

string

required

The Operating System of the runner.

Example:

macos

status

string

required

The status of the runner.

Example:

online

total_count

number

required

Modified at 2022-09-10 00:54:29

Add organization access to a self-hosted runner group in an enterprise

Set self-hosted runners in a group for an enterprise