WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

cancelQueueItem

Description

This function cancel queue item by id.

Parameters

Parameter name Type Description Possible values Example
_id String Required
The queue item id.		   5b60448dd5ac5e4a877ac382

Returns

This API call returns queue object.
To view the parameters returned, click on Queue Object

Example

jetapi backup -F cancelQueueItem -D '_id=5b60448dd5ac5e4a877ac382'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup/api.cgi?function=cancelQueueItem&_id=5b60448dd5ac5e4a877ac382