Create a repository from an unpublished codespace

POST

/user/codespaces/{codespace_name}/publish

Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.

The codespace's token is granted write permissions to the repository, allowing the user to push their changes.

This will fail for a codespace that is already published, meaning it has an associated repository.

You must authenticate using a personal access token with the codespace scope to use this endpoint.

GitHub Apps must have write access to the codespaces repository permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/user/codespaces//publish' \
--header 'Content-Type: application/json' \
--data-raw '{
    "private": false,
    "repository": "monalisa-octocat-hello-world-g4wpq6h95q"
}'

Response Example

201 - Example 1

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Response

application/json

Body

🟠401401

🟠403403

🟠404404

🟠422422

Modified at 2023-08-15 02:59:24

List machine types for a codespace

Start a codespace for the authenticated user