Codespaces-Computer

Verwende die REST-API, um die Verfügbarkeit von Computertypen für einen Codespace zu verwalten.

Informationen zu Codespaces-Computern

Du kannst ermitteln, welche Computertypen verfügbar sind, um einen Codespace entweder in einem bestimmten Repository oder als authentifizierter Benutzer zu erstellen. Weitere Informationen findest du unter Informationen zu Computertypen.

Du kannst diese Informationen auch verwenden, wenn du den Computer eines bestehenden Codespace änderst, indem du seine machine-Eigenschaft aktualisieren. Das Computerupdate erfolgt beim nächsten Neustart des Codespace. Weitere Informationen zu Computertypen findest du unter Ändern des Computertyps für deinen Codespace.

List available machine types for a repository

Works with GitHub Apps

List the machine types available for a given repository based on its configuration.

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

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

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Query parameters
Name, Type, BESCHREIBUNG
`location`string The location to check for available machines. Assigned by IP if not provided.
`client_ip`string IP for location auto-detection when proxying a request

HTTP response status codes

Status code	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Code samples

get/repos/{owner}/{repo}/codespaces/machines

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/codespaces/machines

Response

Status: 200

{
  "total_count": 2,
  "machines": [
    {
      "name": "standardLinux",
      "display_name": "4 cores, 8 GB RAM, 64 GB storage",
      "operating_system": "linux",
      "storage_in_bytes": 68719476736,
      "memory_in_bytes": 8589934592,
      "cpus": 4
    },
    {
      "name": "premiumLinux",
      "display_name": "8 cores, 16 GB RAM, 64 GB storage",
      "operating_system": "linux",
      "storage_in_bytes": 68719476736,
      "memory_in_bytes": 17179869184,
      "cpus": 8
    }
  ]
}

List machine types for a codespace

List the machine types a codespace can transition to use.