Get a custom image definition for GitHub Actions Hosted Runners
GET
/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}
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.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ” org
required
string
The organization name. The name is not case sensitive.
image_definition_id
required
integer
Image definition ID of custom image
Responses
Section titled “ Responses ”Response
Media type application/json
GitHub-hosted runner custom image details
Provides details of a custom runner image
object
id
required
The ID of the image. Use this ID for the image parameter when creating a new larger runner.
integer
platform
required
The operating system of the image.
string
total_versions_size
required
Total size of all the image versions in GB.
integer
name
required
Display name for this image.
string
source
required
The image provider.
string
versions_count
required
The number of image versions associated with the image.
integer
latest_version
required
The latest image version associated with the image.
string
state
required
The number of image versions associated with the image.
string
Examples
Example default
{ "id": 1, "platform": "linux-x64", "name": "CustomImage", "source": "custom", "versions_count": 4, "total_versions_size": 200, "latest_version": "1.3.0", "state": "Ready"}