Skip to content
forgit api docs

List custom images for an organization

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

List custom images for an organization.

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

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
object
total_count
required
integer
images
required
Array<object>
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 
{
  "total_count": 2,
  "image_versions": [
    {
      "version": "1.1.0",
      "size_gb": 75,
      "state": "Ready",
      "created_on": "2024-11-09T23:39:01Z"
    },
    {
      "version": "1.0.0",
      "size_gb": 75,
      "state": "Ready",
      "created_on": "2024-11-08T20:39:01Z"
    }
  ]
}