Last modified November 7, 2024

stopQueueGroup

This function lets you stop a pending or currently processing queue group given its object ID.
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}