Skip to content

Get an image version of a custom image for GitHub Actions Hosted Runners

GET
/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}

Get an image version of a custom image for GitHub Actions Hosted Runners.

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

API method documentation

org
required
string

The organization name. The name is not case sensitive.

image_definition_id
required
integer

Image definition ID of custom image

version
required
string
/^\d+\.\d+\.\d+$/

Version of a custom image

Response

Media type application/json
GitHub-hosted runner custom image version details.

Provides details of a hosted runner custom image version

object
version
required

The version of image.

string
state
required

The state of image version.

string
size_gb
required

Image version size in GB.

integer
created_on
required

The creation date time of the image version.

string
state_details
required

The image version status details.

string
Examples
Example default
{
"version": "1.0.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-08T20:39:01Z"
}