Get details about a codespace export

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.

Script github Verified

by hugo697 ยท 10/25/2023

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 366 days ago
1
type Github = {
2
  token: string;
3
};
4
/**
5
 * Get details about a codespace export
6
 * Gets information about an export of a codespace.
7

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

10
GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
11
 */
12
export async function main(
13
  auth: Github,
14
  codespace_name: string,
15
  export_id: string
16
) {
17
  const url = new URL(
18
    `https://api.github.com/user/codespaces/${codespace_name}/exports/${export_id}`
19
  );
20

21
  const response = await fetch(url, {
22
    method: "GET",
23
    headers: {
24
      Authorization: "Bearer " + auth.token,
25
    },
26
    body: undefined,
27
  });
28
  if (!response.ok) {
29
    const text = await response.text();
30
    throw new Error(`${response.status} ${text}`);
31
  }
32
  return await response.json();
33
}
34