Last modified November 7, 2024

listQueueItems

This function returns a list of queue items associated with the specified queue group ID.
Parameter name Type Description Possible values Example
group_id String REQUIRED The Queue Group ID.   group_id=60898bb20510b07a0833d182

Response

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}