API: Extracting archives
| Target URL | /api.php/Drive/files/extract |
| Required scope | download + upload |
| HTTP Method | POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Description |
|---|---|---|
| path | string | The FileRun path of the archive file. See this page |
| target | string | The FileRun path of the destination folder. See this page |
The account needs to be allowed to download the archive and to upload into the destination folder.
Extracting over a file which already exists in the destination requires that the account is allowed to delete that file (delete_files) and to upload into its folder. Before FileRun 2026.4.0, it required the permission to make changes to that file instead. The replaced content is kept as a previous version of the file, or moved to the trash when file versioning is turned off.