Get details about a codespace export | Sample

2 parameters

codespace_namestringrequired

The name of the codespace.

export_idstringrequired

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

2 status codes

200Response

statestringoptional

State of the latest export

completed_atstringoptional

Completion time of the last export operation

branchstringoptional

Name of the exported branch

shastringoptional

Git commit SHA of the exported branch

idstringoptional

Id for the export details

export_urlstringoptional

Url for fetching export details

html_urlstringoptional

Web url for the exported branch

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.exports.get({
  codespaceName: "Untitled",
  exportId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

{
  "state": "succeeded",
  "completed_at": "2022-01-01T14:59:22Z",
  "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q",
  "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2",
  "id": "latest",
  "export_url": "https://api.github.com/user/codespaces/:name/exports/latest"
}

Was this helpful?

Request

Response

Errors