actions

List GitHub-hosted runners for an organization

Lists all GitHub-hosted runners configured in an organization.

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

get/orgs/{org}/actions/hosted-runners

Request

Base URL: https://api.github.com
URL: https://api.github.com/orgs/{org}/actions/hosted-runners
Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

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

total_countinteger required

Example response

{
  "runners": [
    {
      "id": 5,
      "name": "my-github-hosted-runner",
      "runner_group_id": 2,
      "image_details": {
        "id": "ubuntu-20.04",
        "size_gb": 86,
        "version": "latest"
      },
      "machine_size_details": {
        "id": "8-core",
        "cpu_cores": 8,
        "memory_gb": 32,
        "storage_gb": 300
      },
      "status": "Ready",
      "platform": "linux-x64",
      "maximum_runners": 5,
      "public_ip_enabled": true,
      "public_ips": [
        {
          "enabled": true,
          "prefix": "20.80.208.150",
          "length": 28
        }
      ],
      "last_active_on": "2022-10-09T23:39:01Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 83 revisions of this API.