Parameters
| Parameter name |
Type |
Description |
Possible values |
Example |
|---|
| type |
Integer |
REQUIRED The Queue Group Type. |
4: Download Queue |
type=4 |
|---|
| snapshot_id |
String |
REQUIRED The Parent ID of the Backup. |
Find the Parent ID from the Backup Object. |
snapshot_id=607f602a47fdfc271457147a |
|---|
| items |
List [] |
REQUIRED When not using the snapshot_id. List of Backup Item Object IDs you would like to add to the restore queue. |
The list of Backup Item Objects can be found when using getBackupItems. |
items[]=607f602a47fdfc271457147a |
|---|
| files |
List [] |
List of files/folders paths you want to download. This parameter is only available for file-based backups(homedir files). |
|
files[]=/public_html/index.html&files[]=/test.txt |
|---|
To view the parameters returned by this function, click on Queue Group Object.
Example Call JETAPI
jetbackup5api -F addQueueItems -D "type=4&snapshot_id={$PARENT_ID_OF_BACKUP}"
jetbackup5api -F addQueueItems -D "type=4&items[0]{$BACKUP_ITEM_ID1}&items[1]={$BACKUP_ITEM_ID2}"
jetbackup5api -F addQueueItems -D "type=4&items[]={$BACKUP_ITEM_ID}&files[{$BACKUP_ITEM_ID}][PATH/TO/FILE/]"
success: 1
message: Items added to the queue Successfully
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
_id: 6503ebd682762fb213093772
owner: 6503eba4c6477f48c309376f
owner_name: example
created: 2023-09-15T05:29:58+00:00
started: 2023-09-15T05:29:58+00:00
ended:
type: 4
items: 1
items_completed: 0
finalize:
status: 1
can_rerun:
rerun_failed:
log_id: 6503ebd65f147c7ca3068012
status_time: 2023-09-15T05:29:58+00:00
progress:
_id: 6503ebd682762fb213093774
group_id: 6503ebd682762fb213093772
item_id: 6503ebd682762fb213093773
name:
total: 0
completed: 0
subtotal: 0
subcompleted: 0
name_files:
total_files: 0
completed_files: 0
percentage: 0
percentage_sub: 0
percentage_files: 0
execution_time: 0
actual_time: 0
log_file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6503ebd682762fb213093772.log
log_contents:
data:
account: example
priority: 50
Example Call HTTP
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=addQueueItems&type=4&items[]={BACKUP_ITEM_ID1}&items[]={BACKUP_ITEM_ID2}