provider codespaces POST /user/codespaces/{codespace_name}/start
@utdk/github /user/codespaces/{codespace_name}/start
Start a codespace for the authenticated user
Starts a user's codespace. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_name path required
The name of the codespace.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
codespaces.startForAuthenticatedUser
POST/user/codespaces/{codespace_name}/start
Starts a user's codespace. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.

Parameters

required

The name of the codespace.

Configure credentials above to enable sending.

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

TypeScript

import github from '@utdk/github';

await github.codespaces.startForAuthenticatedUser()