GitHub: List custom images for an organization

GitHub actions.actionsListCustomImagesForOrg: arguments, response, policy and SDK examples.

Operation github.actions_list_custom_images_for_org

Provider route: GET /orgs/{org}/actions/hosted-runners/images/custom. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["actions"]["actionsListCustomImagesForOrg"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.actions.actionsListCustomImagesForOrg(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.actions.actions_list_custom_images_for_org(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.org`	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	object	Root
`images`	array	Required within parent
`images[]`	Model	Each item	Expand Get a custom image definition for Git Hub Actions Hosted Runners — response body
`total_count`	JSON	Required within parent
`total_count (anyOf 1)`	integer	Alternative
`total_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get a custom image definition for Git Hub Actions Hosted Runners — response body

Schemas

Get a custom image definition for Git Hub Actions Hosted Runners — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Provides details of a custom runner image
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`latest_version`	string	Required within parent	The latest image version associated with the image.
`name`	string	Required within parent	Display name for this image.
`platform`	string	Required within parent	The operating system of the image.
`source`	string	Required within parent	The image provider.
`state`	string	Required within parent	The number of image versions associated with the image.
`total_versions_size`	JSON	Required within parent
`total_versions_size (anyOf 1)`	integer	Alternative	Total size of all the image versions in GB.
`total_versions_size (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`versions_count`	JSON	Required within parent
`versions_count (anyOf 1)`	integer	Alternative	The number of image versions associated with the image.
`versions_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.actions_list_custom_images_for_org. Catalog operation: actions/list-custom-images-for-org. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page