Queues

addQueueItems

This function lets you Queue Backup Items for restore or download. To Queue a Backup Job, please execute the runBackupJobManually API call. To Queue a Reindex for a Destination, please execute the reindexDestination API call.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
type	Integer	REQUIRED The Queue Group Type.	1: Backup Queue 2: Restore Queue 4: Download Queue 8: Reindex Queue * incompatible with API command	`type=2`
snapshot_id	String	REQUIRED for Restore(2) or Download(4) Queue Types The Parent ID of the snapshot items.		`snapshot_id=607f602a47fdfc271457147a`
items	List []	Optional for Restore(2) or Download(4) Queue Types List of Backup Item Object IDs you would like to add to the queue.		`items[]=607f602a47fdfc271457147a`
options	List []	List of options you want to execute with the Queue Item(s). This parameter is only available for Restore Queue Type (2). For boolean type options, value is set to false by default.	terminate (boolean): true \| false suspend (boolean): true \| false merge (boolean): true \| false reseller (boolean): true \| false owner (string) package (string)	`options[merge]=true&options[owner]=root&options[package]=default`

Example Call JETAPI

jetbackup5api -F addQueueItems -D "type=2&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=2&items[]={$BACKUP_ITEM_ID}&files[{$BACKUP_ITEM_ID}][{/$FILE}]=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&snapshot_id={$PARENT_ID_OF_BACKUP}

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=addQueueItems&type=4&items[0]={$BACKUP_ITEM_ID1}&items[1]={$BACKUP_ITEM_ID2}

getQueueGroup

This function returns queue group objects by ID.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The ID of the queue group object.		`_id=5b60448dd5ac5e4a877ac382`

Example Call JETAPI

jetbackup5api -F getQueueGroup -D "_id={$QUEUE_GROUP_ID}"

success: 1
message:
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: 6508e9aed49adbd1660f06d9
owner: 6503eba4c6477f48c309376f
owner_name: example
created: 2023-09-19T00:22:06+00:00
started: 2023-09-19T00:22:06+00:00
ended: 2023-09-19T00:22:22+00:00
type: 4
items: 1
items_completed: 1
finalize:
status: 100
can_rerun:
rerun_failed:
log_id: 6508e9aee2238a334103e472
status_time: 2023-09-19T00:22:22+00:00
progress:
   _id: 6508e9aed49adbd1660f06db
   group_id: 6508e9aed49adbd1660f06d9
   item_id: 6508e9aed49adbd1660f06da
   name:
   total: 0
   completed: 0
   subtotal: 1
   subcompleted: 0
   name_files:
   total_files: 0
   completed_files: 0
   percentage: 0
   percentage_sub: 0
   percentage_files: 0
execution_time: 16
actual_time: 0
log_file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9.log
log_contents:
data:
   account: example
   priority: 50

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi??function=getQueueGroup&_id={$QUEUE_GROUP_ID}

getQueueItem

This function returns queue item objects by ID.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The ID of the queue item object.		`_id=5b60448dd5ac5e4a877ac383`

Example Call JETAPI

jetbackup5api -F getQueueItem -D "_id={$QUEUE_ITEM_ID}"

success: 1
message:
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: 6508e9aed49adbd1660f06da
owner: 6503eba4c6477f48c309376f
owner_name: example
created: 2023-09-19T00:22:06+00:00
started: 2023-09-19T00:22:06+00:00
ended: 2023-09-19T00:22:22+00:00
execution_time: 16
type: 4
group_id: 6508e9aed49adbd1660f06d9
priority: 50
status: 100
message: Download completed successfully
progress_id: 6508e9aed49adbd1660f06db
progress:
   _id: 6508e9aed49adbd1660f06db
   group_id: 6508e9aed49adbd1660f06d9
   item_id: 6508e9aed49adbd1660f06da
   name:
   total: 0
   completed: 0
   subtotal: 1
   subcompleted: 0
   name_files:
   total_files: 0
   completed_files: 0
   percentage: 0
   percentage_sub: 0
   percentage_files: 0
file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9/6508e9aed49adbd1660f06da.log
data:
   items:
      0: 6503ebb8ca4e13899d09378c
      1: 6503ebb8ca4e13899d09378d
      2: 6503ebb8ca4e13899d09378e
      3: 6503ebb8ca4e13899d09378f
   account: example
   account_nickname: example
   options:
   nonrecoverable:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi??function=getQueueItem&_id={$QUEUE_ITEM_ID}

listQueueGroups

This function returns a list of queue groups by queue type.

More Info

Parameters

Parameter name Type Description Possible values Example

type Integer REQUIRED The Queue Group Type.

1: Backup Queue

2: Restore Queue

4: Download Queue

8: Reindex Queue

type=2

Parameter name	Type	Description	Possible values	Example
type	Integer	REQUIRED The Queue Group Type.	1: Backup Queue 2: Restore Queue 4: Download Queue 8: Reindex Queue	`type=2`

Reponse

Parameter name	Type	Description	Possible values	Example
groups	List []	This API call returns a list of queue group objects by the specified queue type.	To view the parameters returned by this function, click on Queue Group Object.
total	Integer	The total number of queue groups with the specified queue type.

Example Call JETAPI

jetbackup5api -F listQueueGroups -D "type=4"

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  groups:
    0:
      _id: 6508e9aed49adbd1660f06d9
      owner: 6503eba4c6477f48c309376f
      owner_name: example
      created: 2023-09-19T00:22:06+00:00
      started: 2023-09-19T00:22:06+00:00
      ended: 2023-09-19T00:22:22+00:00
      type: 4
      items: 1
      items_completed: 1
      finalize:
      status: 100
      can_rerun:
      rerun_failed:
      log_id: 6508e9aee2238a334103e472
      status_time: 2023-09-19T00:22:22+00:00
      progress:
        _id: 6508e9aed49adbd1660f06db
        group_id: 6508e9aed49adbd1660f06d9
        item_id: 6508e9aed49adbd1660f06da
        name:
        total: 0
        completed: 0
        subtotal: 1
        subcompleted: 0
        name_files:
        total_files: 0
        completed_files: 0
        percentage: 0
        percentage_sub: 0
        percentage_files: 0
      execution_time: 16
      actual_time: 16
      log_file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9.log
      log_contents:
      data:
        account: example
        priority: 50
  total: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listQueueItems&type=2

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

listQueueItems

This function returns a list of queue items associated with the specified queue group ID.

More Info

Parameters

Parameter name Type Description Possible values Example

group_id String REQUIRED The Queue Group ID. group_id=60898bb20510b07a0833d182

Parameter name	Type	Description	Possible values	Example
group_id	String	REQUIRED The Queue Group ID.		`group_id=60898bb20510b07a0833d182`

Reponse

Parameter name	Type	Description	Possible values	Example
items	List []	Returns a list of queue items associated with the specified group ID.	To view the parameters returned by this function, click on Queue Item Object.
total	Integer	The total number of Queue Items in the Queue Group

Example Call JETAPI

jetbackup5api -F listQueueItems -D "group_id={$QUEUE_GROUP_ID}"

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  items:
    0:
      _id: 6508e9aed49adbd1660f06da
      owner: 6503eba4c6477f48c309376f
      owner_name: example
      created: 2023-09-19T00:22:06+00:00
      started: 2023-09-19T00:22:06+00:00
      ended: 2023-09-19T00:22:22+00:00
      execution_time: 16
      type: 4
      group_id: 6508e9aed49adbd1660f06d9
      priority: 50
      status: 100
      message: Download completed successfully
      progress_id: 6508e9aed49adbd1660f06db
      progress:
        _id: 6508e9aed49adbd1660f06db
        group_id: 6508e9aed49adbd1660f06d9
        item_id: 6508e9aed49adbd1660f06da
        name:
        total: 0
        completed: 0
        subtotal: 1
        subcompleted: 0
        name_files:
        total_files: 0
        completed_files: 0
        percentage: 0
        percentage_sub: 0
        percentage_files: 0
      file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9/6508e9aed49adbd1660f06da.log
      data:
        items:
          0: 6503ebb8ca4e13899d09378c
          1: 6503ebb8ca4e13899d09378d
          2: 6503ebb8ca4e13899d09378e
          3: 6503ebb8ca4e13899d09378f
        account: example
        account_nickname: example
        options:
        nonrecoverable:
  total: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listQueueItems&group_id={$QUEUE_GROUP_ID}

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

clearQueue

This function lets you clear all non-pending/non-processing items in the queue.

More Info

Parameters

To view available listing parameters, please visit List Parameters.

Example Call JETAPI

jetbackup5api -F clearQueue

success: 1
message: Queue cleared 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:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=clearQueue

stopQueueGroup

This function lets you stop a pending or currently processing queue group given its object ID.

More Info

Parameters

Parameter name Type Description Possible values Example

_id String REQUIRED The ID of the queue group. _id=5b60448dd5ac5e4a877ac382

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The ID of the queue group.		`_id=5b60448dd5ac5e4a877ac382`

Example Call JETAPI

jetbackup5api -F stopQueueGroup -D "_id={$QUEUE_GROUP_OBJECT_ID}"

success: 1
message: Queue Group stop signal sent
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=stopQueueGroup&_id={$QUEUE_GROUP_OBJECT_ID}

stopAllQueueGroup

This function lets you stop all pending and currently processing groups in the queue.

More Info

Parameters

To view available listing parameters, please visit List Parameters.

Example Call JETAPI

jetbackup5api -F stopAllQueueGroup

success: 1
message: Stop signal sent to all queue groups
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=stopAllQueueGroup

manageQueuePriority

This function lets you create and manage Queue Priority Groups.

More Info

Parameters

Parameter name Type Description Possible values Example

_id String REQUIRED on action modify. The ID of the queue priority group. _id=60898b7f2ba85218685acfd9

action String REQUIRED The action you want to perform.

create

modify

name String REQUIRED on action create. Queue priority group name. name=VIP

tags List [] List of Account Tag IDs that is associated to the queue priority group. tags[]=608b077566c0e32488215a62

backup_priority Integer REQUIRED on action create. The backup priority level of the queue priority group.

restore_priority Integer REQUIRED on action create. The restore priority level of the queue priority group.

download_priority Integer REQUIRED on action create. The download priority level of the queue priority group.

default Boolean Sets the priority group as the default priority.

1 (true)

empty/null (false)

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED on action modify. The ID of the queue priority group.		`_id=60898b7f2ba85218685acfd9`
action	String	REQUIRED The action you want to perform.	create modify
name	String	REQUIRED on action create. Queue priority group name.		`name=VIP`
tags	List []	List of Account Tag IDs that is associated to the queue priority group.		`tags[]=608b077566c0e32488215a62`
backup_priority	Integer	REQUIRED on action create. The backup priority level of the queue priority group.
restore_priority	Integer	REQUIRED on action create. The restore priority level of the queue priority group.
download_priority	Integer	REQUIRED on action create. The download priority level of the queue priority group.
default	Boolean	Sets the priority group as the default priority.	1 (true) empty/null (false)

Example Call JETAPI

jetbackup5api -F manageQueuePriority -D "action=create&name=test&backup_priority=40&restore_priority=20&download_priority=10&clone_priority=30&tags[0]={$TAG_ID1}&tags[1]={$TAG_ID2}"

jetbackup5api -F manageQueuePriority -D "_id={$QUEUE_PRIORITY_GROUP_ID}&action=modify&name=test&backup_priority=40&restore_priority=20&download_priority=10&clone_priority=30&tags[0]={$TAG_ID1}&tags[1]={$TAG_ID2}"

success: 1
message: Queue Priority Created/Updated 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: 6508feba65219ded7d044202
  name: test
  tags:
    0: 6508f84ca80e83597707ca92
    1: 6508f9127d8b1bca210caec2
  backup_priority: 40
  clone_priority: 30
  restore_priority: 20
  download_priority: 10
  default:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageQueuePriority&action=create&name=test&backup_priority=40&restore_priority=20&download_priority=10&clone_priority=30&tags[0]={$TAG_ID1}&tags[1]={$TAG_ID2}

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageQueuePriority&_id={$QUEUE_PRIORITY_GROUP_ID}&action=modify&name=test&backup_priority=40&restore_priority=20&download_priority=10&clone_priority=30&tags[0]={$TAG_ID1}&tags[1]={$TAG_ID2}

getQueuePriority

This function returns queue priority object by ID.

More Info

Parameters

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The ID of the queue priority object.		`_id=60898b7f2ba85218685acfdb`

Example Call JETAPI

jetbackup5api -F getQueuePriority -D "_id={$QUEUE_PRIORITY_ID}"

success: 1
message:
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: 6508feba65219ded7d044202
name: test
tags:
   0: 6508f84ca80e83597707ca92
   1: 6508f9127d8b1bca210caec2
backup_priority: 40
clone_priority: 30
restore_priority: 20
download_priority: 10
default:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi??function=getQueuePriority&_id={$QUEUE_PRIORITY_ID}

listQueuePriorities

This function returns a list of queue priority objects.

More Info

Parameters

Reponse

Parameter name	Type	Description	Possible values	Example
priorities	List []	This API call returns a list of all available queue priority objects.	To view the parameters returned by this function, click on Queue Priority Object.
total	Integer	The total number of queue priority groups available/set up.

Example Call JETAPI

jetbackup5api -F listQueuePriorities

success: 1
message:
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  priorities:
    0:
      _id: 65075381a8f98c6ea7022b61
      name: High
      tags:
      backup_priority: 10
      clone_priority: 10
      restore_priority: 10
      download_priority: 10
      default:
    1:
      _id: 65075381a8f98c6ea7022b62
      name: Normal
      tags:
      backup_priority: 50
      clone_priority: 50
      restore_priority: 50
      download_priority: 50
      default: 1
    2:
      _id: 65075381a8f98c6ea7022b63
      name: Low
      tags:
      backup_priority: 90
      clone_priority: 90
      restore_priority: 90
      download_priority: 90
      default:
    3:
      _id: 6508feba65219ded7d044202
      name: test
      tags:
        0: 6508f84ca80e83597707ca92
        1: 6508f9127d8b1bca210caec2
      backup_priority: 40
      clone_priority: 30
      restore_priority: 20
      download_priority: 10
      default:
  total: 4

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listQueuePriorities

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

deleteQueuePriority

This function lets you delete a Queue Priority Group given its object ID.

More Info

Parameters

Parameter name Type Description Possible values Example

_id String REQUIRED The ID of the queue priority group. _id=60b13b895997721ca63f55e2

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The ID of the queue priority group.		`_id=60b13b895997721ca63f55e2`

Example Call JETAPI

jetbackup5api -F deleteQueuePriority -D "_id={$QUEUE_PRIORITY_GROUP_ID}"

success: 1
message: Queue priority Deleted 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:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=deleteQueuePriority&_id={$QUEUE_PRIORITY_GROUP_ID}

rerunFailedQueueGroup

This function retries failed items and is only available for Failed or Partially Completed backup jobs.

More Info

Parameters

Parameter name Type Description Possible values Example

_id String REQUIRED The ID of the Queue Group that you want to retry failed items. _id=5b60448dd5ac5e4a877ac382

Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED The ID of the Queue Group that you want to retry failed items.		`_id=5b60448dd5ac5e4a877ac382`

Example Call JETAPI

jetbackup5api -F rerunFailedQueueGroup -D "_id={$QUEUE_GROUP_ID}"

success: 1
message: Failed Items Added To The Queue
system:
  version: 5.3.5
  version_panel: 5.3.5
  tier: BETA
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 6572463ff6c2139b0702eb46
  owner: 655e901d8179c9052b0ce5e6
  owner_name: test
  created: 2023-12-07T22:25:03+00:00
  started: 2023-12-07T22:25:03+00:00
  ended:
  type: 2
  items: 1
  items_completed: 0
  finalize:
  status: 1
  can_rerun: 1
  rerun_failed: 1
  log_id: 6572463f1ad7fd79560350e2
  status_time: 2023-12-07T22:31:19+00:00
  progress:
    _id: 6572463ff6c2139b0702eb48
    group_id: 6572463ff6c2139b0702eb46
    item_id: 6572463ff6c2139b0702eb47
    name:
    total: 3
    completed: 0
    subtotal: 1
    subcompleted: 0
    name_files:
    total_files: 0
    completed_files: 0
    percentage: 0
    percentage_sub: 0
    percentage_files: 0
  execution_time: 376
  actual_time: 0
  log_file: /usr/local/jetapps/var/log/jetbackup5/queue/2_6572463ff6c1853b0702eb46.log
  log_contents:
  data:
    account: test
    priority: 100050

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=rerunFailedQueueGroup&_id={$QUEUE_GROUP_ID}

Parameter Dictionary

Queue Group Object

**Queue Group Object**
Parameter name	Type	Description	Examples
_id	String	Unique ID of the Queue Group Object.	60835efa26762d5a3134394e
owner	String	Unique ID of the backup owner.	6009c86db68d1601154a76ff
owner_name	String	Name of the backup owner.	user
created	String	Date-time when the Queue Group was generated.	2021-04-23T23:57:46+00:00
started	String	Date-time when the Queue Group started processing	2021-04-23T23:57:46+00:00
ended	String	Date-time when the Queue Group finished processing	2021-04-24T01:09:10+00:00
type	Integer	Queue Type for the Queue Group Object.	1 (backup) 2 (restore) 4 (download) 8 (reindex)
items	Integer	Number of items in the Queue Group.	5
items_completed	Integer	Number of items that has completed processing in the Queue Group.	5
finalize	boolean flag	Flags if all items in the Queue Group has been completed	1 (true) empty/null (false)
status	Integer	Status of the Queue Group process	1: Pending 2: Processing 100: Completed 101: Partially Completed 102: Failed 103: Aborted 104: Never Finished
log_id	String	Unique ID of the log associated to the Queue Group.	608222b9c268d2175921b412
status_time	String	Date-time when the status was last updated	2021-04-23T01:28:43+00:00
execution_time	Integer	Time it took for the Queue Group to be queued until it completes processing, in seconds.	3685
actual_time	Integer	Time it took for the Queue Group to complete processing, in seconds.	3143
log_file	String	Path of the log associated to the Queue Group.	/usr/local/jetapps/var/log/jetbackup5/queue/2_60835e6f26762d5a3134394c.log
data	List []	A list of corresponding data associated with the Queue Group Type.	Queue Type 1: _id (string): destination ID name (string): destination name snapshot (boolean): Backup on Demand manually (boolean): Manually executed backup Queue Type 2 & 4: account (string): account name priority (integer): account priority level Queue Type 8: _id (string): destination ID name (string): destination name

Queue Item Object

**Queue Item Object**
Parameter name	Type	Description	Examples
_id	String	Unique ID of the Queue Group Object.	`'_id=608b3ff3897f7b1a0e6ab532'`
owner	String	Unique ID of the backup owner.	`'owner=6009c86db68d1601154a76ff'`
owner_name	String	Name of the backup owner.	user
created	String	Date-time when the Queue Group was generated.	2021-04-23T23:57:46+00:00
started	String	Date-time when the Queue Group started processing	2021-04-23T23:57:46+00:00
ended	String	Date-time when the Queue Group finished processing	2021-04-24T01:09:10+00:00
execution_time	Integer	Time it took for the Queue Group to be queued until it completes processing, in seconds.	3685
type	Integer	Queue Type for the Queue Group Object.	1 (backup) 2 (restore) 4 (download) 8 (reindex)
group_id	String	Unique ID of the Queue Group Object.	`'group_id=608b3ff3897f7b1a0e6ab531'`
priority	Integer	The priority level associated to the Queue Item.
status	Integer	Status of the Queue Group process	1: Pending 2: Processing 100: Completed 101: Partially Completed 102: Failed 103: Aborted 104: Never Finished
message	String	Status message associated to the Queue Item.	Restore completed successfully
file	String	Path of the log associated to the Queue Item.	/usr/local/jetapps/var/log/jetbackup5/queue/2_60835e6f26762d5a3134394c/60898bb20510b07a0833d183.log
data	List []	A list of corresponding data associated with the Queue Item Type.	Queue Type 1: _id (string): Backup Job ID manually (boolean): Manually executed backup snapshot (boolean): Backup on Demand account (string): Backup Job name destinations (List): list of destinations specified on the Backup Job Queue Type 2 & 4: items (List): list of backup IDs selected for Restore/Download. account (string): account name options (List): List of options selected for the Queue Item(s). terminate (boolean): true \| false merge (boolean): true \| false suspend (boolean): true \| false owner (string) reseller (boolean): true \| false package (string) Queue Type 8: N/A

Queue Priority Object

**Queue Priority Object**
Parameter name	Type	Description	Possible values	Example
_id	String	The ID of the queue priority group.		`'_id=60898b7f2ba85218685acfd9'`
name	String	Queue priority group name.		`'name=VIP'`
tags	List []	List of Account Tag IDs that is associated to the queue priority group.		`'tags[]=608b077566c0e32488215a62'`
backup_priority	Integer	The backup priority level of the queue priority group.
restore_priority	Integer	The restore priority level of the queue priority group.
download_priority	Integer	The download priority level of the queue priority group.
default	Boolean	Whether the queue priority group is the default group.	1 (true) empty/null (false)

JETAPI Documentation

On This Page:

Queues

addQueueItems

getQueueGroup

getQueueItem

listQueueGroups

listQueueItems

clearQueue

stopQueueGroup

stopAllQueueGroup

manageQueuePriority

getQueuePriority

listQueuePriorities

deleteQueuePriority

rerunFailedQueueGroup

Parameter Dictionary

Queue Group Object

Queue Item Object

Queue Priority Object

On This Page: