extract_archive
Unpack all or selected archive paths into a new named folder in the background; existing files are preserved and unsafe, encrypted, or link entries are skipped.
Instructions
Extract an archive (all of it, or selected paths) into a new folder named after it, in the background. Existing files are never overwritten; name clashes get a numeric suffix. Returns a job; poll get_job (wait=true) until done, then result_node_id is the new folder. Encrypted, link and unsafe-path entries are skipped. Requires files:upload.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| base | No | directory inside the archive the extraction is relative to; empty for the top level | |
| path | No | absolute Gopan path of the archive, alternative to node_id | |
| paths | No | full paths inside the archive to extract (files or directories under base); empty extracts everything under base | |
| node_id | No | archive file node UUID | |
| parent_id | No | folder to create the output folder in; default is the archive's own folder | |
| parent_path | No | folder path, alternative to parent_id |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| url | No | ||
| kind | Yes | fetch_url or extract_archive | |
| title | Yes | file name once known, otherwise the link's host; archive name for extraction | |
| status | Yes | queued, running, done, failed or canceled | |
| parent_id | No | target folder; omitted means the root | |
| bytes_done | Yes | ||
| created_at | Yes | ||
| error_code | No | why it failed; on success GOT_HTML means the server returned a web page instead of a file | |
| files_done | No | ||
| bytes_total | No | ||
| files_total | No | ||
| finished_at | No | ||
| error_message | No | ||
| files_skipped | No | archive entries skipped: unsafe paths, links or invalid names | |
| result_node_id | No | the downloaded file, or the folder files were extracted into |