0

Get zip download status

by
Published Oct 17, 2025

Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped.

Script box Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Box = {
3
  token: string;
4
};
5
/**
6
 * Get zip download status
7
 * Returns the download status of a `zip` archive, allowing an application to
8
inspect the progress of the download as well as the number of items that
9
might have been skipped.
10
 */
11
export async function main(auth: Box, zip_download_id: string) {
12
  const url = new URL(
13
    `https://api.box.com/2.0/zip_downloads/${zip_download_id}/status`,
14
  );
15

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