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.

lockLatestSnap

Description

With this function, you can lock a backup snapshot for a specific account.
A locked snapshot will never be cleared so it advised setting a TTL for the lock.

Parameters

Parameter name Type Description Possible values Example
account String Required
The account name.		   acct01
depth Integer
Specific backup to lock, relative to the latest snapshot.
If you don't pass this value the default is the newest backup(0).
   pass 2 to lock the 2nd newest backup.
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 lockLatestSnap -D 'account=acct01&depth=0&ttl=7'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup/api.cgi?function=lockLatestSnap&account=acct01&depth=0&ttl=7