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.

manageSettingsSnapshots

Description

With this function, you can manage snapshots settings.

Parameters

Parameter name Type Description Possible values Example
backup String The backup job you want to use for snapshots.   5b28fa5fd5ac5e5ff62760b2
maxperaccount Integer The maximum snapshots allowed for each Account.   1
ttl Integer Auto remove snapshots after XX days.   2
rulesize Integer Automatically disable creating snapshots if Disk Space Usage reaches to X.   5
rulesizetype String Automatically disable creating snapshots if Disk Space Usage reaches to X.
  • MB
  • GB
  • TB
 GB
ruleinodes Integer Automatically disable creating snapshots if Inodes Count reaches to X.   50000

Returns

This API call returns snapshots setting object.
To view the parameters returned, click on Snapshots Setting Object

Example

jetapi backup -F manageSettingsSnapshots -D 'maxperaccount=2'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup/api.cgi?function=manageSettingsSnapshots&maxperaccount=2