Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
actions

Get an enterprise custom image definition for GitHub Actions Hosted Runners

Get an enterprise custom image definition for GitHub Actions Hosted Runners.

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

get/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}

Path parameters

enterprisestring required

The slug version of the enterprise name.

image_definition_idinteger required

Image definition ID of custom image

Response

Response

idinteger required

The ID of the image. Use this ID for the image parameter when creating a new larger runner.

platformstring required

The operating system of the image.

total_versions_sizeinteger required

Total size of all the image versions in GB.

namestring required

Display name for this image.

sourcestring required

The image provider.

versions_countinteger required

The number of image versions associated with the image.

latest_versionstring required

The latest image version associated with the image.

statestring required

The number of image versions associated with the image.

Example response

{
  "id": 1,
  "platform": "linux-x64",
  "total_versions_size": 200,
  "name": "CustomImage",
  "source": "custom",
  "versions_count": 4,
  "latest_version": "1.3.0",
  "state": "Ready"
}