Skip to main content
Zip downloads represent a successful request to create a ZIP archive with files and folders.

​
Zip download

Represents a successful request to create a zip archive of a list of files and folders.
PropertyTypeRequiredDescription
download_urlstringNoThe URL that can be used to download the zip archive. A Get request to this URL will start streaming the items requested. By default, this URL is only valid for a few seconds, until the expires_at time, unless a download is started after which it is valid for the duration of the download. It is important to note that the domain and path of this URL might change between API calls, and therefore it’s important to use this URL as-is.
status_urlstringNoThe URL that can be used to get the status of the zip archive being downloaded. A Get request to this URL will return the number of files in the archive as well as the number of items already downloaded or skipped. By default, this URL is only valid for a few seconds, until the expires_at time, unless a download is started after which the URL is valid for 12 hours from the start of the download. It is important to note that the domain and path of this URL might change between API calls, and therefore it’s important to use this URL as-is.
expires_atstringNoThe time and date when this archive will expire. After this time the status_url and download_url will return an error. By default, these URLs are only valid for a few seconds, unless a download is started after which the download_url is valid for the duration of the download, and the status_url is valid for 12 hours from the start of the download.
name_conflictsarray of array of objectNoA list of conflicts that occurred when trying to create the archive. This would occur when multiple items have been requested with the same name. To solve these conflicts, the API will automatically rename an item and return a mapping between the original item’s name and its new name. For every conflict, both files will be renamed and therefore this list will always be a multiple of 2.
Example
{
  "download_url": "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content",
  "status_url": "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status",
  "expires_at": "2020-07-22T11:26:08Z",
  "name_conflicts": [
    [
      {
        "id": "12345",
        "type": "file",
        "original_name": "Report.pdf",
        "download_name": "3aa6a7.pdf"
      },
      {
        "id": "34325",
        "type": "file",
        "original_name": "Report.pdf",
        "download_name": "5d53f2.pdf"
      }
    ]
  ]
}

​
Zip download status

The status of a zip archive being downloaded.
PropertyTypeRequiredDescription
total_file_countintegerNoThe total number of files in the archive.
downloaded_file_countintegerNoThe number of files that have already been downloaded.
skipped_file_countintegerNoThe 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.
skipped_folder_countintegerNoThe 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.
stateenum<string>NoThe state of the archive being downloaded. Available options: in_progress, failed, succeeded.
Example
{
  "total_file_count": 20,
  "downloaded_file_count": 10,
  "skipped_file_count": 5,
  "skipped_folder_count": 5,
  "state": "succeeded"
}
Last modified on July 9, 2026