Sample - GitHub REST API
GET/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}

Get a custom image definition for GitHub Actions Hosted Runners

Get a custom image definition for GitHub Actions Hosted Runners.

OAuth 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.
image_definition_idintegerrequired
Image definition ID of custom image

1 status code
200Response
idintegerrequired
The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.
platformstringrequired
The operating system of the image.
total_versions_sizeintegerrequired
Total size of all the image versions in GB.
namestringrequired
Display name for this image.
sourcestringrequired
The image provider.
versions_countintegerrequired
The number of image versions associated with the image.
latest_versionstringrequired
The latest image version associated with the image.
statestringrequired
The number of image versions associated with the image.