Codespaces

Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Help for wherever you are on your GitHub journey.

Can be one of

Name

All {{ name }} guides

{{ name }} learning paths

Actions

GitHub began rolling these changes out to enterprises on

Enter a search term to find it in the GitHub Docs.

Codespaces - GitHub Docs

Use the REST API to manage GitHub Codespaces.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Quickstart

About GitHub's APIs

Resources in the REST API

API Versions

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

OpenAPI description

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Endpoints for fine-grained PATs

Permissions for GitHub Apps

Permissions for fine-grained PATs

Breaking changes

Overview

Using the API

Script with JavaScript

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Integrator best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runners

Variables

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

Marketplace

OAuth Authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check Runs

Check Suites

Checks

Codes of conduct

Code Scanning

Organizations

Organization secrets

Machines

Repository secrets

User secrets

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Copilot for Business

Copilot

Alerts

Dependabot

Dependency review

Dependency submission

Software bill of materials (SBOM)

Dependency Graph

Deploy keys

Deployment branch policies

Deployments

Environments

Protection rules

Deployment statuses

Emojis

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Organization

Repository

User

Interactions

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Community

Statistics

Traffic

Metrics

Source imports

Users

Migrations

Blocking users

Members

Outside Collaborators

Personal access tokens

Rules

Security Managers

Packages

Pages

Boards

Cards

Columns

Projects (classic)

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Global security advisories

Repository security advisories

Security advisories

Teams

Discussion comments

Discussions

Emails

Followers

GPG Keys

Git SSH Keys

SSH signing keys

Social accounts

Repository Webhook Configuration

Repository Webhook Deliveries

Repository Webhooks

Repository webhooks

monalisa-octocat-hello-world-g4wpq6h95q

monalisa-octocat-hello-world-3f89ada1j3

Lists the codespaces associated to a specified repository and the authenticated user.
You must authenticate using an access token with the <code>codespace</code> scope to use this endpoint.
GitHub Apps must have read access to the <code>codespaces</code> repository permission to use this endpoint.

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

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

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

List codespaces in a repository for the authenticated user

Git ref (typically a branch name) for this codespace

The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.

location

Creates a codespace owned by the authenticated user in the specified repository.
You must authenticate using an access token with the <code>codespace</code> scope to use this endpoint.
GitHub Apps must have write access to the <code>codespaces</code> repository permission to use this endpoint.

Create a codespace in a repository