org_hosted_runner_custom_image_versions

Creates, updates, deletes, gets or lists an org_hosted_runner_custom_image_versions resource.

Overview

Name	org_hosted_runner_custom_image_versions
Type	Resource
Id	github.actions.org_hosted_runner_custom_image_versions

Fields

The following fields are returned by SELECT queries:

get_custom_image_version_for_org

Response

Name	Datatype	Description
created_on	string	The creation date time of the image version. (example: 2024-11-09T23:39:01Z)
size_gb	integer	Image version size in GB.
state	string	The state of image version. (example: Ready)
state_details	string	The image version status details. (example: None)
version	string	The version of image. (example: 1.0.0)

list_custom_image_versions_for_org

Response

Name	Datatype	Description
image_versions	array
total_count	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_image_version_for_org	select	org, image_definition_id, 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.
list_custom_image_versions_for_org	select	image_definition_id, org		List image versions of a custom image for an organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
delete_custom_image_version_from_org	delete	org, image_definition_id, version		Delete an image version of custom image from the organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
image_definition_id	integer	Image definition ID of custom image
org	string	The organization name. The name is not case sensitive.
version	string	Version of a custom image

SELECT examples

get_custom_image_version_for_org

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.

SELECT
created_on,
size_gb,
state,
state_details,
version
FROM github.actions.org_hosted_runner_custom_image_versions
WHERE org = '{{ org }}' -- required
AND image_definition_id = '{{ image_definition_id }}' -- required
AND version = '{{ version }}' -- required
;

list_custom_image_versions_for_org

List image versions of a custom image for an organization.

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

SELECT
image_versions,
total_count
FROM github.actions.org_hosted_runner_custom_image_versions
WHERE image_definition_id = '{{ image_definition_id }}' -- required
AND org = '{{ org }}' -- required
;

DELETE examples

delete_custom_image_version_from_org

Delete an image version of custom image from the organization.

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

DELETE FROM github.actions.org_hosted_runner_custom_image_versions
WHERE org = '{{ org }}' --required
AND image_definition_id = '{{ image_definition_id }}' --required
AND version = '{{ version }}' --required
;