GitHub: List machine types for a codespace

GitHub codespaces.codespacesCodespaceMachinesForAuthenticatedUser: arguments, response, policy and SDK examples.

Operation github.codespaces_codespace_machines_for_authenticated_user

Provider route: GET /user/codespaces/{codespace_name}/machines. 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["codespaces"]["codespacesCodespaceMachinesForAuthenticatedUser"]>[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.codespaces.codespacesCodespaceMachinesForAuthenticatedUser(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.codespaces.codespaces_codespace_machines_for_authenticated_user(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.codespace_name`	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
`machines`	array	Required within parent
`machines[]`	Model	Each item	Expand List machine types for a codespace — response body — machines item
`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: List machine types for a codespace — response body — machines item

Schemas

List machine types for a codespace — response body — machines item

Field	Type	Presence	Description and constraints
`$`	object	Root	A description of the machine powering a codespace.
`cpus`	JSON	Required within parent
`cpus (anyOf 1)`	integer	Alternative	How many cores are available to the codespace.
`cpus (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`display_name`	string	Required within parent	The display name of the machine includes cores, memory, and storage.
`memory_in_bytes`	JSON	Required within parent
`memory_in_bytes (anyOf 1)`	integer	Alternative	How much memory is available to the codespace.
`memory_in_bytes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`name`	string	Required within parent	The name of the machine.
`operating_system`	string	Required within parent	The operating system of the machine.
`prebuild_availability`	JSON	Required within parent
`prebuild_availability (anyOf 1)`	string	Alternative	Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. Known values: none, ready, in_progress
`prebuild_availability (anyOf 2)`	null	Alternative
`storage_in_bytes`	JSON	Required within parent
`storage_in_bytes (anyOf 1)`	integer	Alternative	How much storage is available to the codespace.
`storage_in_bytes (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.codespaces_codespace_machines_for_authenticated_user. Catalog operation: codespaces/codespace-machines-for-authenticated-user. 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