provider codespaces GET
/repos/{owner}/{repo}/codespaces/machines @utdk/github
/repos/{owner}/{repo}/codespaces/machines 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.
- owner path required
- The account owner of the repository. The name is not case sensitive.
- string
- repo path required
- The name of the repository without the `.git` extension. The name is not case sensitive.
- string
- location query
- The location to check for available machines. Assigned by IP if not provided.
- string
- client_ip query
- IP for location auto-detection when proxying a request
- string
- ref query
- The branch or commit to check for prebuild availability and devcontainer restrictions.
- string
Try it
Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import github from '@utdk/github';
await github.codespaces.repoMachinesForAuthenticatedUser()