Máquinas de codespaces
A API de máquinas de codespaces permite que um usuário determine 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.
Sobre a API de máquinas de codespace
A API de máquinas de codespaces permite que um usuário determine 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, consulte "Sobre tipos de máquinas".
Você também pode usar essas informações alterando a máquina de um codespace existente, atualizando a propriedade máquina. A atualização da máquina ocorrerá na próxima vez que o codespace for reiniciado. Para obter mais informações, consulte ""Mudar 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.
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
| Headers |
|---|
| Nome, Tipo, Descrição |
acceptstringSetting to |
| Path parameters |
| Nome, Tipo, Descrição |
ownerstringObrigatórioThe account owner of the repository. The name is not case sensitive. |
repostringObrigatórioThe name of the repository. The name is not case sensitive. |
| Parâmetros de consulta |
| Nome, Tipo, Descrição |
locationstringThe location to check for available machines. Assigned by IP if not provided. |
client_ipstringIP for location auto-detection when proxying a request |
HTTP response status codes
| Status code | Descrição |
|---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
500 | Internal Error |
Amostras de código
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <TOKEN>" \
https://api.github.com/repos/OWNER/REPO/codespaces/machinesResponse
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
| Headers |
|---|
| Nome, Tipo, Descrição |
acceptstringSetting to |
| Path parameters |
| Nome, Tipo, Descrição |
codespace_namestringObrigatórioThe name of the codespace. |
HTTP response status codes
| Status code | Descrição |
|---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
500 | Internal Error |
Amostras de código
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <TOKEN>" \
https://api.github.com/user/codespaces/CODESPACE_NAME/machinesResponse
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
}
]
}