List self-hosted runners for an enterprise

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

GET/enterprises/{enterprise}/actions/runners

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

Headers

Link string

Example:

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

runners array[Self hosted runners object]

optional

items Self hosted runners object

A self hosted runner

busy boolean

required

id integer

required

The id of the runner.

Example: 5

labels array[Self hosted runner label object]

required

name string

required

The name of the runner.

Example: iMac

os string

required

The Operating System of the runner.

Example: macos

status string

required

The status of the runner.

Example: online

total_count number

optional

Response Example: 200 application/json

{
  "runners": [
    {
      "busy": true,
      "id": 23,
      "labels": [
        {
          "id": 5,
          "name": "self-hosted",
          "type": "read-only"
        },
        {
          "id": 7,
          "name": "X64",
          "type": "read-only"
        },
        {
          "id": 11,
          "name": "Linux",
          "type": "read-only"
        }
      ],
      "name": "linux_runner",
      "os": "linux",
      "status": "online"
    },
    {
      "busy": false,
      "id": 24,
      "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"
        }
      ],
      "name": "mac_runner",
      "os": "macos",
      "status": "offline"
    }
  ],
  "total_count": 2
}

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/runners