Skip to main content

Zip files or folders

This method permits to zip files or folders in the library. The resulting zip file is stored to the library and can be downloaded in a second step. Alternatively, the "Download file(s)" method should be used if you want to download multiple files as a zip file without the zip being stored in the library.

URL

(POST) projects/{projectid}/files/{locale}/zip

PARAMETERS

token

The connection token

Required

projectid

The project

Required

locale

The language.

Required

zipname

The path/name of the zip file. Example: "myfiles.zip", "folder1/new.zip", etc.

Required

name

Indicate a ":"-separated list of files or folders. If you specify a folder, all files and sub folders will be included in the zip.Example: "names=file1.doc:folder\file2.doc:folder2"

Required

overwrite

Default: false. If false then the operation will fail if the zip file already exists. If true, then an eventually existing zip file will be replaced.

Optional

 

RESULTS

On success, returns the details (ApiFileInfo) for the newly created zip file.





JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.