create_download
Create download tasks from HTTP, FTP, magnet links, or local .torrent/.nzb files, specifying an existing destination folder or using your default Synology Download Station destination.
Instructions
Create one or more download tasks, from URIs or from a local .torrent / .nzb file. destination must be an existing folder, share-relative (DS doesn't create folders; make a new one first with File Station's create_folder when File Station write is enabled, or ask the user to create it in DSM). Omit it to use your default destination (a non-manager who has none must set it first with set_download_config, because DS won't start their tasks until then). Returns the new task IDs when DSM provides them (not for URLs with username / password); long magnet links and URI lists are supported.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uri | No | One or more source URIs, comma-separated: HTTP, HTTPS, FTP, magnet and others. Pass this or `torrent_file_path`, not both. | |
| password | No | Password for a protected `uri`; not for torrent files. | |
| username | No | User name for a protected `uri`; not for torrent files. | |
| destination | No | Existing folder to download into, share-relative (`video/Torrents`). Omit it to use your default destination. | |
| torrent_file_path | No | Path on this machine to a `.torrent` or `.nzb` file, inside one of the allowed local folders (/root/Downloads), or below it. Pass this or `uri`, not both. |