Codespacesのマシン

Codespaces machines APIを使うと、指定されたリポジトリ上あるいは認証を受けたユーザとしてcodespaceを作成するために利用できるマシンタイプを判断できます。

Codespaces machines APIについて

Codespaces machines APIを使うと、指定されたリポジトリ上あるいは認証を受けたユーザとしてcodespaceを作成するために利用できるマシンタイプを判断できます。詳しい情報については「マシンタイプについて」を参照してください。

この情報は、machineプロパティを更新することによって既存のcodespaceのマシンを変更する際にも利用できます。マシンの更新は、codespaceが次に再起動された際に行われます。詳しい情報については「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.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名前, 種類, 説明
`owner`string必須 The account owner of the repository. The name is not case sensitive.
`repo`string必須 The name of the repository. The name is not case sensitive.
クエリパラメータ
名前, 種類, 説明
`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	説明
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

コードサンプル

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

curl \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  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.