Create a repository from an unpublished codespace

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.

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" }'

Responses

🟢201Response

application/json

Body

A codespace.

billable_owner

object (Simple User)

required

A GitHub user.

avatar_url

string <uri>

required

Example:

https://github.com/images/error/octocat_happy.gif

string | null

optional

events_url

string

required

Example:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

required

Example:

https://api.github.com/users/octocat/followers

following_url

string

required

Example:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

required

Example:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

required

Example:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

required

Example:

https://github.com/octocat

integer

required

Example:

string

required

Example:

octocat

name

string | null

optional

node_id

string

required

Example:

MDQ6VXNlcjE=

organizations_url

string <uri>

required

Example:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

required

Example:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

required

Example:

https://api.github.com/users/octocat/repos

site_admin

boolean

required

starred_at

string

optional

Example:

"2020-07-09T00:17:55Z"

starred_url

string

required

Example:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

required

Example:

https://api.github.com/users/octocat/subscriptions

type

string

required

Example:

User

url

string <uri>

required

Example:

https://api.github.com/users/octocat

created_at

string <date-time>

required

Example:

2011-01-26T19:01:12.000Z

devcontainer_path

string | null

optional

Path to devcontainer.json from repo root used to create Codespace.

Example:

.devcontainer/example/devcontainer.json

display_name

string | null

optional

Display name for this codespace.

Example:

bookish space pancake

environment_id

string | null

required

UUID identifying this codespace's environment.

Example:

26a7c758-7299-4a73-b978-5a92a7ae98a0

git_status

object

required

Details about the codespace's git repository.

ahead

integer

optional

The number of commits the local repository is ahead of the remote.

Example:

behind

integer

optional

The number of commits the local repository is behind the remote.

Example:

has_uncommitted_changes

boolean

optional

Whether the local repository has uncommitted changes.

has_unpushed_changes

boolean

optional

Whether the local repository has unpushed changes.

ref

string

optional

The current branch (or SHA if in detached HEAD state) of the local repository.

Example:

main

integer

required

Example:

idle_timeout_minutes

integer | null

required

The number of minutes of inactivity after which this codespace will be automatically stopped.

Example:

idle_timeout_notice

string | null

optional

Text to show user when codespace idle timeout minutes has been overriden by an organization policy

last_used_at

string <date-time>

required

Last known time this codespace was started.

Example:

2011-01-26T19:01:12.000Z

location

enum<string>

required

The Azure region where this codespace is located.

Allowed values:

EastUsSouthEastAsiaWestEuropeWestUs2

Example:

WestUs2

machine

object (Codespace machine) | null

required

A description of the machine powering a codespace.

cpus

integer

required

How many cores are available to the codespace.

Example:

display_name

string

required

The display name of the machine includes cores, memory, and storage.

Example:

4 cores, 8 GB RAM, 64 GB storage

memory_in_bytes

integer

required

How much memory is available to the codespace.

Example:

8589934592

name

string

required

The name of the machine.

Example:

standardLinux

operating_system

string

required

The operating system of the machine.

Example:

linux

prebuild_availability

enum<string> | enum<null>

required

Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.

Allowed values:

nonereadyin_progress

Example:

ready

storage_in_bytes

integer

required

How much storage is available to the codespace.

Example:

68719476736

machines_url

string <uri>

required

API URL to access available alternate machine types for this codespace.

name

string

required

Automatically generated name of this codespace.

Example:

monalisa-octocat-hello-world-g4wpq6h95q

owner

object (Simple User)

required

A GitHub user.

pending_operation

boolean | null

optional

Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.

pending_operation_disabled_reason

string | null

optional

Text to show user when codespace is disabled by a pending operation

prebuild

boolean | null

required

Whether the codespace was created from a prebuild.

Example:

false

publish_url

string <uri> | null

optional

API URL to publish this codespace to a new repository.

pulls_url

string <uri> | null

required

API URL for the Pull Request associated with this codespace, if any.

recent_folders

array[string]

required

repository

object (Full Repository)

required

Full Repository

allow_auto_merge

boolean

optional

Example:

false

allow_forking

boolean

optional

Example:

true

allow_merge_commit

boolean

optional

Example:

true

allow_rebase_merge

boolean

optional

Example:

true

allow_squash_merge

boolean

optional

Example:

true

allow_update_branch

boolean

optional

Example:

true

anonymous_access_enabled

boolean

optional

Whether anonymous git access is allowed.

Default:

true

archive_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived

boolean

required

assignees_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url

string

required

Example:

https://github.com/octocat/Hello-World.git

code_of_conduct

object (Code Of Conduct Simple)

optional

Code of Conduct Simple

collaborators_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/contributors

created_at

string <date-time>

required

Example:

2011-01-26T19:01:12.000Z

default_branch

string

required

Example:

master

delete_branch_on_merge

boolean

optional

Example:

false

deployments_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/deployments

description

string | null

required

Example:

This your first repo!

disabled

boolean

required

Returns whether or not this repository disabled.

downloads_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/downloads

events_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/events

fork

boolean

required

forks

integer

required

forks_count

integer

required

Example:

forks_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/forks

full_name

string

required

Example:

octocat/Hello-World

git_commits_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url

string

required

Example:

git:github.com/octocat/Hello-World.git

has_discussions

boolean

required

Example:

true

has_downloads

boolean

required

Example:

true

has_issues

boolean

required

Example:

true

has_pages

boolean

required

has_projects

boolean

required

Example:

true

has_wiki

boolean

required

Example:

true

homepage

string <uri> | null

required

Example:

https://github.com

hooks_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/hooks

html_url

string <uri>

required

Example:

https://github.com/octocat/Hello-World

integer

required

Example:

1296269

is_template

boolean

optional

Example:

true

issue_comment_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/labels{/name}

language

string | null

required

languages_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/languages

license

object (License Simple) | null

required

License Simple

master_branch

string

optional

merge_commit_message

enum<string>

optional

The default value for a merge commit message.

PR_TITLE - default to the pull request's title.

PR_BODY - default to the pull request's body.

BLANK - default to a blank commit message.

Allowed values:

PR_BODYPR_TITLEBLANK

Example:

PR_BODY

merge_commit_title

enum<string>

optional

The default value for a merge commit title.

PR_TITLE - default to the pull request's title.

MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

Allowed values:

PR_TITLEMERGE_MESSAGE

Example:

PR_TITLE

merges_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/merges

milestones_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url

string <uri> | null

required

Example:

git:git.example.com/octocat/Hello-World

name

string

required

Example:

Hello-World

network_count

integer

required

Example:

node_id

string

required

Example:

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues

integer

required

open_issues_count

integer

required

Example:

organization

object (Simple User) | null

optional

A GitHub user.

owner

object (Simple User)

required

A GitHub user.

parent

object (Repository)

optional

A repository on GitHub.

permissions

object

optional

private

boolean

required

pulls_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at

string <date-time>

required

Example:

2011-01-26T19:06:43.000Z

releases_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/releases{/id}

security_and_analysis

object (security-and-analysis) | null

optional

size

integer

required

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

Example:

108

source

object (Repository)

optional

A repository on GitHub.

squash_merge_commit_message

enum<string>

optional

The default value for a squash merge commit message:

PR_BODY - default to the pull request's body.

COMMIT_MESSAGES - default to the branch's commit messages.

BLANK - default to a blank commit message.

Allowed values:

PR_BODYCOMMIT_MESSAGESBLANK

Example:

PR_BODY

squash_merge_commit_title

enum<string>

optional

The default value for a squash merge commit title:

PR_TITLE - default to the pull request's title.

COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).

Allowed values:

PR_TITLECOMMIT_OR_PR_TITLE

Example:

PR_TITLE

ssh_url

string

required

Example:

git@github.com:octocat/Hello-World.git

stargazers_count

integer

required

Example:

stargazers_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/stargazers

statuses_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count

integer

required

Example:

subscribers_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/subscription

svn_url

string <uri>

required

Example:

https://svn.github.com/octocat/Hello-World

tags_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/tags

teams_url

string <uri>

required

Example:

http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token

string | null

optional

template_repository

object (Repository) | null

optional

A repository on GitHub.

topics

array[string]

optional

Example:

["octocat","atom","electron","API"]

trees_url

string

required

Example:

http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at

string <date-time>

required

Example:

2011-01-26T19:14:43.000Z

url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World

use_squash_pr_title_as_default

boolean

optional

Example:

false

visibility

string

optional

The repository visibility: public, private, or internal.

Example:

public

watchers

integer

required

watchers_count

integer

required

Example:

web_commit_signoff_required

boolean

optional

Example:

false

retention_expires_at

string <date-time> | null

optional

When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"

Example:

2011-01-26T20:01:12.000Z

retention_period_minutes

integer | null

optional

Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

Example:

runtime_constraints

object

optional

allowed_port_privacy_settings

array[string] | null

optional

The privacy settings a user can select from when forwarding a port.

start_url

string <uri>

required

API URL to start this codespace.

state

enum<string>

required

State of this codespace.

Allowed values:

UnknownCreatedQueuedProvisioningAvailableAwaitingUnavailableDeletedMovedShutdownArchivedStartingShuttingDownFailedExportingUpdatingRebuilding

Example:

Available

stop_url

string <uri>

required

API URL to stop this codespace.

updated_at

string <date-time>

required

Example:

2011-01-26T19:01:12.000Z

url

string <uri>

required

API URL for this codespace.

web_url

string <uri>

required

URL to access this codespace on the web.

🟠401401

🟠403403

🟠404404

🟠422422