Last modified November 7, 2024

getQueueGroup

This function returns queue group objects by ID.
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}