Computadores codespaces
Use a API REST para gerenciar a disponibilidade de tipos de computador para um codespace.
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 "Sobre os tipos de computadores".
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 "Como alterar o tipo de computador para seu codespace".
List available machine types for a repository
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.
Parâmetros
Cabeçalhos |
---|
Nome, Type, Descrição |
accept stringSetting to |
Parâmetros de caminho |
Nome, Type, Descrição |
owner stringObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo stringObrigatórioThe name of the repository. The name is not case sensitive. |
Parâmetros de consulta |
Nome, Type, Descrição |
location stringThe location to check for available machines. Assigned by IP if not provided. |
client_ip stringIP for location auto-detection when proxying a request |
Códigos de status de resposta HTTP
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
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.
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.
Parâmetros
Cabeçalhos |
---|
Nome, Type, Descrição |
accept stringSetting to |
Parâmetros de caminho |
Nome, Type, Descrição |
codespace_name stringObrigatórioThe name of the codespace. |
Códigos de status de resposta HTTP
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
curl \
-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, 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
}
]
}