Get details about a codespace export

GET

/user/codespaces/{codespace_name}/exports/{export_id}

Gets information about an export of a codespace.

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

GitHub Apps must have read access to the codespaces_lifecycle_admin repository permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/user/codespaces//exports/'

Response Example

200 - Example 1

{
    "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q",
    "completed_at": "2021-01-01T19:01:12.000Z",
    "export_url": "https://api.github.com/user/codespaces/:name/exports/latest",
    "html_url": "https://github.com/octocat/hello-world/tree/:branch",
    "id": "latest",
    "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2",
    "state": "succeeded | failed | in_progress"
}

Request

Path Params

codespace_name

string

required

The name of the codespace.

export_id

string

required

The ID of the export operation, or latest. Currently only latest is currently supported.

Responses

🟢200Response

application/json

Body

An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest

branch

string | null

optional

Name of the exported branch

Example:

codespace-monalisa-octocat-hello-world-g4wpq6h95q

completed_at

string <date-time> | null

optional

Completion time of the last export operation

Example:

2021-01-01T19:01:12.000Z

export_url

string

optional

Url for fetching export details

Example:

https://api.github.com/user/codespaces/:name/exports/latest

html_url

string | null

optional

Web url for the exported branch

Example:

https://github.com/octocat/hello-world/tree/:branch

string

optional

Id for the export details

Example:

latest

sha

string | null

optional

Git commit SHA of the exported branch

Example:

fd95a81ca01e48ede9f39c799ecbcef817b8a3b2

state

string | null

optional

State of the latest export

Example:

succeeded | failed | in_progress

🟠404404

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

Export a codespace for the authenticated user

List machine types for a codespace