BObox
Zip Downloads

Get zip download status

Changed on

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.

get/zip_downloads/{zip_download_id}/status

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/zip_downloads/{zip_download_id}/status
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

zip_download_idstring required

The unique identifier that represent this zip archive.

Response

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

total_file_countinteger

The total number of files in the archive.

downloaded_file_countinteger

The number of files that have already been downloaded.

skipped_file_countinteger

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.

skipped_folder_countinteger

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.

state'in_progress' | 'failed' | 'succeeded'

The state of the archive being downloaded.

Example response

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

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status