API: Zipping files and folders
| Target URL | /api.php/Drive/files/zip |
| Required scope | download + upload |
| HTTP Method | POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Required | Description |
|---|---|---|---|
| paths | array | Yes | The FileRun paths of the files and folders to add to the archive. See this page |
| target | string | Yes | The FileRun path of the folder where the archive is created. See this page |
| archiveName | string | Yes | The name of the archive file. The extension must be zip. |
The account needs to be allowed to download the items and to upload into the target folder. Since FileRun 2026.4.0 it no longer needs the permission to make changes. A folder is added together with its contents.
If a file with the archive name already exists in the target folder, the items are appended to it, which requires that the account is allowed to edit that file (edit_files). Otherwise the archive is created. The size of the added items counts against the space quota of the account.
The response carries one message per added item in the msg array.