Sample - GitHub REST API
GET/orgs/{org}/actions/hosted-runners/{hosted_runner_id}

Get a GitHub-hosted runner for an organization

Gets a GitHub-hosted runner configured in an organization.

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

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
orgstringrequired
The organization name. The name is not case sensitive.
hosted_runner_idintegerrequired
Unique identifier of the GitHub-hosted runner.

1 status code
200Response
idintegerrequired
The unique identifier of the hosted runner.
namestringrequired
The name of the hosted runner.
runner_group_idintegeroptional
The unique identifier of the group that the hosted runner belongs to.
image_detailsobjectrequired
Provides details of a hosted runner image
machine_size_detailsobjectrequired
Provides details of a particular machine spec.
statusstringrequired
The status of the runner.
Allowed:ReadyProvisioningShutdownDeletingStuck
platformstringrequired
The operating system of the image.
maximum_runnersintegeroptional
The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.
Default:10
public_ip_enabledbooleanrequired
Whether public IP is enabled for the hosted runners.
public_ipsarray<PublicIPForAGitHubHostedLargerRunners>optional
The public IP ranges when public IP is enabled for the hosted runners.
last_active_onstringoptional
The time at which the runner was last used, in ISO 8601 format.
image_genbooleanoptional
Whether custom image generation is enabled for the hosted runners.