v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB
enterprise-admin

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 manage_runners:enterprise scope to use this endpoint.

get/enterprises/{enterprise}/actions/runners

Path parameters

enterprisestring required

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

Query parameters

per_pageinteger

The number of results per page (max 100).

pageinteger

Page number of the results to fetch.

Response

Response

total_countnumber

Example response

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