Zips

Zips methods to manage zip stream requests

Methods

Create Zip

POST /zips/create

Creates zip file for given files. A zip_id is returned to keep track of the status of zip creation process.

Parameters

file_ids:File ids separated by commas. Ex: 1,2,3,4

Example response:

{
  "status": "OK",
  "zip_id": "7645645"
}

List Zips

GET /zips/list

Lists active zip files.

Example response:

  {
    "zips": [
        {
            "created_at": "2013-09-07T21:32:03",
            "id": 6546533
        },
        {
            "created_at": "2013-09-07T21:32:03",
            "id": 7645645

        }
    ],
    "status": "OK"
}

Get Zip

GET /zips/<zip_id>

Gives detailed information about the give zip file id. Check the zip creation process status with your zip_id. When the process is done, you will get url value along with size and missing_files. You might need to poll this end point until you get an url value. missing_files is an array of file names which are not included into the zip file for some reason.

Parameters

zip_id:ID of the zip file process

Example response:

{
  "status": "OK",
  "url": "http://...",
  "size": "4235344523",
  "missing_files": [{
    "missing": true,
    "name": "Missing File Name"
  }]
}