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.

manageBackupLock

Description

With this function, you can lock a list of snapshots.
A locked snapshot will never be cleared so it advised setting a TTL for the lock.
If one of the snapshots is invalid the locking process will be canceled.

NOTICE: manageBackupLock has been deprecated and will be removed and replaced by manageBackup in future versions.

Parameters

Parameter name Type Description Possible values Example
_ids[] List Required
List of snaps ids.		   _ids[]=5c3b4b66d5ac5e79b52006c3&_ids[]=5c536fe2d5ac5e3a82442973
state Boolean Whether to lock backups.
  • lock => 1
  • unlock => 0
 1
lock_ttl Integer
The lock days number.
If you don't pass this value the default is locked forever(0).
   pass 4 to lock this backup for 4 days.

Returns

Doesn't return any data.

Example

jetapi backup -F manageBackupLock -D '_ids[]=5c3b4b66d5ac5e79b52006c3&_ids[]=5c536fe2d5ac5e3a82442973&state=1&lock_ttl=90'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup/api.cgi?function=manageBackupLock&_ids[]=5c3b4b66d5ac5e79b52006c3&_ids[]=5c536fe2d5ac5e3a82442973&state=1&lock_ttl=90