put_downloads_id
Update a download task's parameters such as status, priority, or name by providing its ID.
Instructions
Updates the Download task with the given id
Error codes: task_not_found, invalid_operation, invalid_file, invalid_url, not_implemented, out_of_memory, invalid_task_type, hibernating, need_bt_stopped_done, bt_tracker_not_found, too_many_tasks, invalid_address, port_conflict, invalid_priority, internal_error, ctx_file_error, exists, port_outside_range, none, internal, disk_full, unknown, parse_error, http_301, http_400, http_401, http_402, http_403, http_404, http_405
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id__path | Yes | (Path parameter) | |
| id | No | id | |
| type | No | The valid download types are: — Values: `bt`: bittorrent download; `nzb`: newsgroup download; `http`: HTTP download; `ftp`: FTP download | |
| name | No | ||
| status | No | The valid download status are: — Values: `stopped`: task is stopped, can be resumed by setting the status to downloading; `queued`: task will start when a new download slot is available the queue position is stored in queue_pos attribute; `starting`: task is preparing to start download; `stopping`: task is gracefully stopping; `error`: there was a problem with the download, you can get an error code in the error field; `done`: the download is over. For bt you can resume seeding setting the status to seeding if the ratio is not reached yet; `checking`: (only valid for nzb) download is over, the downloaded files are being checked using par2; `repairing`: (only valid for nzb) download is over, the downloaded files are being repaired using par2; `extracting`: only valid for nzb) download is over, the downloaded files are being extracted; `seeding`: (only valid for bt) download is over, the content is Change to being shared to other users. The task will automatically stop once the seed ratio has been reached; `retry`: You can set a task status to ‘retry’ to restart the download task. | |
| size | No | download size (in Bytes) | |
| queue_pos | No | position in download queue (0 if not queued) | |
| io_priority | No | The valid download priorities are: — Values: `low`: low; `normal`: normal; `high`: high | |
| tx_bytes | No | transmitted bytes (including protocol overhead) | |
| rx_bytes | No | received bytes (including protocol overhead) | |
| tx_rate | No | current transmit rate (in byte/s) | |
| rx_rate | No | current receive rate (in byte/s) | |
| tx_pct | No | transmit percentage (without protocol overhead) | |
| rx_pct | No | received percentage (without protocol overhead) | |
| error | No | An error code | |
| created_ts | No | timestamp of the download creation time — Unix timestamp (seconds since epoch). | |
| eta | No | estimated remaining download time (in seconds) | |
| download_dir | No | directory where the file(s) will be saved (base64 encoded) | |
| stop_ratio | No | Only relevant for bittorrent tasks. Once the transmit ration has been reached the task will stop seeding. | |
| archive_password | No | ( only relevant for nzb ) password for extracting downloaded archives | |
| info_hash | No | ( only relevant for bt ) torrent info_hash encoded in hexa | |
| piece_length | No | ( only relevant for bt ) torrent piece length in bytes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||