Pontos de extremidade da API REST para máquinas Codespaces

Sobre os computadores Codespaces

Você pode determinar quais tipos de máquina estão disponíveis para criar um codespace, seja em um determinado repositório ou como um usuário autenticado. Para obter mais informações, confira "Alterando o tipo de máquina para seu codespace".

Use também essas informações ao alterar o computador de um codespace existente atualizando a propriedade machine. A atualização da máquina ocorrerá na próxima vez que o codespace for reiniciado. Para obter mais informações, confira "Alterando o tipo de máquina para seu codespace".

List available machine types for a repository

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

OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

Tokens de acesso refinados para "List available machine types for a repository"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Codespaces metadata" repository permissions (read)

Parâmetros para "List available machine types for a repository"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`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
`ref` string The branch or commit to check for prebuild availability and devcontainer restrictions.

Códigos de status de resposta HTTP para "List available machine types for a repository"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "List available machine types for a repository"

Exemplo de solicitação

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

curl -L \
  -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, 16 GB RAM, 64 GB storage",
      "operating_system": "linux",
      "storage_in_bytes": 68719476736,
      "memory_in_bytes": 17179869184,
      "cpus": 4
    },
    {
      "name": "premiumLinux",
      "display_name": "8 cores, 32 GB RAM, 64 GB storage",
      "operating_system": "linux",
      "storage_in_bytes": 68719476736,
      "memory_in_bytes": 34359738368,
      "cpus": 8
    }
  ]
}

List machine types for a codespace

List the machine types a codespace can transition to use.

OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

Tokens de acesso refinados para "List machine types for a codespace"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Codespaces metadata" repository permissions (read)

Parâmetros para "List machine types for a codespace"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`codespace_name` string Obrigatório The name of the codespace.

Códigos de status de resposta HTTP para "List machine types for a codespace"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "List machine types for a codespace"

Exemplo de solicitação

get/user/codespaces/{codespace_name}/machines

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

Response

Status: 200

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