Box Developer Documentation
Log in

Zip download status

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

The status of a zip archive being downloaded.

integer
10
0

The number of files that have already been downloaded.

integer
5
0

The number of files that have been skipped as they could not be downloaded. In many cases this is due to permission issues that have surfaced between the creation of the request for the archive and the archive being downloaded.

integer
5
0

The number of folders that have been skipped as they could not be downloaded. In many cases this is due to permission issues that have surfaced between the creation of the request for the archive and the archive being downloaded.

string
succeeded
"in_progress"

The state of the archive being downloaded.

Value is one of in_progress,failed,succeeded

integer
20
0
10000

The total number of files in the archive.

Response Example

{
  "downloaded_file_count": 10,
  "skipped_file_count": 5,
  "skipped_folder_count": 5,
  "state": "succeeded",
  "total_file_count": 20
}