codespace_export_details
Creates, updates, deletes, gets or lists a codespace_export_details resource.
Overview
| Name | codespace_export_details |
| Type | Resource |
| Id | github.codespaces.codespace_export_details |
Fields
The following fields are returned by SELECT queries:
- get_export_details_for_authenticated_user
Response
| Name | Datatype | Description |
|---|---|---|
id | string | Id for the export details (example: latest) |
branch | string | Name of the exported branch (example: codespace-monalisa-octocat-hello-world-g4wpq6h95q) |
completed_at | string (date-time) | Completion time of the last export operation (example: 2021-01-01T19:01:12Z) |
export_url | string | Url for fetching export details (example: https://api.github.com/user/codespaces/:name/exports/latest) |
html_url | string | Web url for the exported branch (example: https://github.com/octocat/hello-world/tree/:branch) |
sha | string | Git commit SHA of the exported branch (example: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2) |
state | string | State of the latest export (example: succeeded | failed | in_progress) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_export_details_for_authenticated_user | select | codespace_name, export_id | Gets information about an export of a codespace. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
codespace_name | string | The name of the codespace. |
export_id | string | The ID of the export operation, or latest. Currently only latest is currently supported. |
SELECT examples
- get_export_details_for_authenticated_user
Gets information about an export of a codespace.
OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
SELECT
id,
branch,
completed_at,
export_url,
html_url,
sha,
state
FROM github.codespaces.codespace_export_details
WHERE codespace_name = '{{ codespace_name }}' -- required
AND export_id = '{{ export_id }}' -- required
;