Skip to main content

machines

Overview

Namemachines
TypeResource
Idgithub.codespaces.machines

Fields

NameDatatypeDescription
namestringThe name of the machine.
memory_in_bytesintegerHow much memory is available to the codespace.
operating_systemstringThe operating system of the machine.
prebuild_availabilitystringWhether 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 is the type of prebuild available, or "none" if none are available.
storage_in_bytesintegerHow much storage is available to the codespace.
cpusintegerHow many cores are available to the codespace.
display_namestringThe display name of the machine includes cores, memory, and storage.

Methods

NameAccessible byRequired ParamsDescription
codespace_machines_for_authenticated_userSELECTcodespace_nameList the machine types a codespace can transition to use.

You must authenticate using an access token with the codespace scope to use this endpoint.
repo_machines_for_authenticated_userSELECTlocation, owner, repoList the machine types available for a given repository based on its configuration.

Location is required.

You must authenticate using an access token with the codespace scope to use this endpoint.