v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-03-2585861610.1 MB
enterprise-admin

List self-hosted runners in a group for an enterprise

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

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

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

Path parameters

enterprisestring required

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

runner_group_idinteger required

Unique identifier of the self-hosted runner group.

Query parameters

per_pageinteger

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

pageinteger

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

Response

Response

total_countnumber required

Example response

{
  "runners": [
    {
      "id": 5,
      "runner_group_id": 1,
      "name": "iMac",
      "os": "macos",
      "status": "online"
    }
  ]
}