Restore

addQueueItems

This function lets you Queue Backup Items for restore. For the complete parameters available for this API call, please click HERE.

Parameters

Parameter name Type Description Possible values Example
type Integer REQUIRED The Queue Group Type. 2: Restore Queue 'type=2'
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
options List [] List of options you want to execute with the Restore Queue. For boolean type options, value is set to false by default.
  • terminate (boolean): true | false
  • suspend (boolean - False by default; Only neccessary to add if you want to suspend account after restoring): true | false
  • merge (boolean): true | false
  • reseller (boolean): true | false
  • owner (string)
  • package (string)
 options[terminate]=true&options[owner]=reseller1&options[package]=reseller_pkg&options[suspend]=true
files List [] List of files/folders paths you want to restore. This parameter is only available for file-based backups(homedir files).   'files[]=/public_html/index.html&files[]=/test.txt'

Response

This API call returns queue group objects.
To view the parameters returned by this function, click on Queue Group Object.

Example Call JETAPI

jetbackup5api -F addQueueItems -D "type=2&snapshot_id=[$SNAPSHOT_ID]&items[]={$BACKUP_ITEM_OBJECT_ID}&options[owner]=reseller&files[$BACKUP_ITEM_OBJECT_ID][/public_html]=Directory"

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: 650c9c213dcf1714310f0cbc
  owner: 6503d48bfc45b1addf0a9636
  owner_name: user
  created: 2023-09-21T19:40:17+00:00
  started: 2023-09-21T19:40:17+00:00
  ended:
  type: 2
  items: 1
  items_completed: 0
  finalize:
  status: 1
  can_rerun:
  rerun_failed:
  log_id: 650c9c21fc1f3391ad0c8da2
  status_time: 2023-09-21T19:40:17+00:00
  progress:
    _id: 650c9c213dcf1714310f0cbe
    group_id: 650c9c213dcf1714310f0cbc
    item_id: 650c9c213dcf1714310f0cbd
    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/2_650c9c213dcf1714310f0cbc.log
  log_contents:
  data:
    account: user
    priority: 100010

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=addQueueItems&type=2&snapshot_id=[$SNAPSHOT_ID]&items[]={$BACKUP_ITEM_OBJECT_ID}&options[owner]=reseller&files[$BACKUP_ITEM_OBJECT_ID][/public_html]=Directory