Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!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.
Request
Path Parameters
Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8MddThe unique identifier that represent this zip archive.
Response
Returns the status of the zip archive that is being downloaded.
Returned when the access token provided in the Authorization header
is not recognized or not provided.
Returned when an authorization header is provided but the user does not have access to the items.
Returns an error if the ID of this download request is not valid, or if the status of a download is requested before the download has been started.
An unexpected client error.
Request Example
curl -i -X GET "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status" \
-H "authorization: Bearer <ACCESS_TOKEN>"await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!);client.zip_downloads.get_zip_download_status(zip_download.status_url)await client.ZipDownloads.GetZipDownloadStatusAsync(statusUrl: NullableUtils.Unwrap(zipDownload.StatusUrl));Response Example
{
"downloaded_file_count": 10,
"skipped_file_count": 5,
"skipped_folder_count": 5,
"state": "succeeded",
"total_file_count": 20
}