WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

addQueueDownload

Description

This function download item.

Parameters

Parameter name Type Description Possible values Example
_id String Required
The backup id.		   5b605a47d5ac5e134d7dc527
type String The type of file you want to download.
  • backup
  • destination
  
files[] List
List of the path to the file/folder you want to download.
This parameter is only for file-based backup(homedir files, directories backup)/destination.
   files[]=/public_html/index.html&files[]=/test.txt

Returns

Parameter name Type Description Possible values Example
queue_id String The queue item id.   5b60448dd5ac5e4a877ac382
ready Boolean      
filename String     Download in Progress
download_id String      
added Boolean      

Example

jetapi backup -F addQueueDownload -D '_id=5b605a47d5ac5e134d7dc527&files[]=/public_html/index.html&files[]=/test.txt'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup/api.cgi?function=addQueueDownload&_id=5b605a47d5ac5e134d7dc527&files[]=/public_html/index.html&files[]=/test.txt