Skip to main content
GET
/
zip_downloads
/
{zip_download_id}
/
status
cURL
curl -i -X GET "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "total_file_count": 20,
  "downloaded_file_count": 10,
  "skipped_file_count": 5,
  "skipped_folder_count": 5,
  "state": "succeeded"
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
zip_download_id
string
required

The unique identifier that represent this zip archive.

Response

Returns the status of the zip archive that is being downloaded.

The status of a zip archive being downloaded.

​
total_file_count
integer

The total number of files in the archive.

Required range: 0 <= x <= 10000
Example:

20

​
downloaded_file_count
integer

The number of files that have already been downloaded.

Required range: x >= 0
Example:

10

​
skipped_file_count
integer

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.

Required range: x >= 0
Example:

5

​
skipped_folder_count
integer

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.

Required range: x >= 0
Example:

5

​
state
enum<string>
default:in_progress

The state of the archive being downloaded.

Available options:
in_progress,
failed,
succeeded
Example:

"succeeded"