provider codespaces GET /repos/{owner}/{repo}/codespaces/new
@utdk/github /repos/{owner}/{repo}/codespaces/new
Get default attributes for a codespace
Gets the default attributes for codespaces created by the user with the repository. 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
ref query
The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.
string
client_ip query
An alternative IP for default location auto-detection, such as when proxying a request.
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.

codespaces.preFlightWithRepoForAuthenticatedUser
GET/repos/{owner}/{repo}/codespaces/new
Gets the default attributes for codespaces created by the user with the repository. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.

Parameters

required

The account owner of the repository. The name is not case sensitive.

required

The name of the repository without the `.git` extension. The name is not case sensitive.

The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.

An alternative IP for default location auto-detection, such as when proxying a request.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.codespaces.preFlightWithRepoForAuthenticatedUser()