List machine types for a codespace

GET

/user/codespaces/{codespace_name}/machines

List the machine types a codespace can transition to use.

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

GitHub Apps must have read access to the codespaces_metadata repository permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/user/codespaces//machines'

Response Example

200 - Example 1

{
    "machines": [
        {
            "cpus": 4,
            "display_name": "4 cores, 8 GB RAM, 64 GB storage",
            "memory_in_bytes": 8589934592,
            "name": "standardLinux",
            "operating_system": "linux",
            "prebuild_availability": "ready",
            "storage_in_bytes": 68719476736
        }
    ],
    "total_count": 0
}

Request

Path Params

codespace_name

string

required

The name of the codespace.

Responses

🟢200Response

application/json

Body

machines

array[object (Codespace machine) {7}]

required

cpus

integer

required

How many cores are available to the codespace.

Example:

display_name

string

required

The display name of the machine includes cores, memory, and storage.

Example:

4 cores, 8 GB RAM, 64 GB storage

memory_in_bytes

integer

required

How much memory is available to the codespace.

Example:

8589934592

name

string

required

The name of the machine.

Example:

standardLinux

operating_system

string

required

The operating system of the machine.

Example:

linux

prebuild_availability

enum<string> | enum<null>

required

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.

Allowed values:

nonereadyin_progress

Example:

ready

storage_in_bytes

integer

required

How much storage is available to the codespace.

Example:

68719476736

total_count

integer

required

🔵304304

🟠401401

🟠403403

🟠404404

🔴500500

Modified at 2023-08-15 02:59:24

Get details about a codespace export

Create a repository from an unpublished codespace