Skip to content

zip_downloads.md

Latest commit

 

History

History
170 lines (122 loc) · 6.04 KB

zip_downloads.md

File metadata and controls

170 lines (122 loc) · 6.04 KB

ZipDownloadsManager

Create zip download

Creates a request to download multiple files and folders as a single zip archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a download_url and a status_url that can be used to download the archive.

The limit for an archive is either the Account's upload limit or 10,000 files, whichever is met first.

Note: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.

This operation is performed by calling function create_zip_download.

See the endpoint docs at API Reference.

client.zip_downloads.create_zip_download(
    [
        CreateZipDownloadItems(id=file_1.id, type=DownloadZipItemsTypeField.FILE),
        CreateZipDownloadItems(id=file_2.id, type=DownloadZipItemsTypeField.FILE),
        CreateZipDownloadItems(id=folder_1.id, type=DownloadZipItemsTypeField.FOLDER),
    ],
    download_file_name="zip",
)

Arguments

  • items List[CreateZipDownloadItems]
    • A list of items to add to the zip archive. These can be folders or files.
  • download_file_name Optional[str]
    • The optional name of the zip archive. This name will be appended by the .zip file extension, for example January Financials.zip.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type ZipDownload.

If the zip archive is ready to be downloaded, the API will return a response that will include a download_url, a status_url, as well as any conflicts that might have occurred when creating the request.

Download zip archive

Returns the contents of a zip archive in binary format. This URL does not require any form of authentication and could be used in a user's browser to download the archive to a user's device.

By default, this URL is only valid for a few seconds from the creation of the request for this archive. Once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created.

The URL of this endpoint should not be considered as fixed. Instead, use the Create zip download API to request to create a zip archive, and then follow the download_url field in the response to this endpoint.

This operation is performed by calling function get_zip_download_content.

See the endpoint docs at API Reference.

client.zip_downloads.get_zip_download_content(zip_download.download_url)

Arguments

  • download_url str
    • The URL that can be used to download created zip archive. Example: https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type ByteStream.

Returns the content of the items requested for this download, formatted as a stream of files and folders in a zip archive.

Get zip download status

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.

This endpoint can only be accessed once the download has started. Subsequently this endpoint is valid for 12 hours from the start of the download.

The URL of this endpoint should not be considered as fixed. Instead, use the Create zip download API to request to create a zip archive, and then follow the status_url field in the response to this endpoint.

This operation is performed by calling function get_zip_download_status.

See the endpoint docs at API Reference.

client.zip_downloads.get_zip_download_status(zip_download.status_url)

Arguments

  • status_url str
    • The URL that can be used to get the status of the zip archive being downloaded. Example: https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type ZipDownloadStatus.

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

Download ZIP

Creates a zip and downloads its content

This operation is performed by calling function download_zip.

client.zip_downloads.download_zip(
    [
        DownloadZipItems(id=file_1.id, type=DownloadZipItemsTypeField.FILE),
        DownloadZipItems(id=file_2.id, type=DownloadZipItemsTypeField.FILE),
        DownloadZipItems(id=folder_1.id, type=DownloadZipItemsTypeField.FOLDER),
    ],
    download_file_name="zip",
)

Arguments

  • items List[DownloadZipItems]
    • A list of items to add to the zip archive. These can be folders or files.
  • download_file_name Optional[str]
    • The optional name of the zip archive. This name will be appended by the .zip file extension, for example January Financials.zip.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type ByteStream.