Archiving APIs

This setting includes parameters, defaults and usages for archiving.

Archiving Rules

There are 4 type of archiving rules:

• DiskUsage
• Age
• Versions
• DateRange

The rules can be specified using the Json parameter ArchivingRules.

Default Rules

If the json parameter "ArchivingRules" is not specified, then these rules are automatically added to the backup sets

Files and Folders

The default rule is Age.

MinimumRevisions = 10.

Days = 30.

Filters = *.* (all files).

This rule is defined as: Keep any revision for at least 30 days, and at least 10 revisions in total, for each file.

Common Parameter

This parameter is common to all types of Files and Folders archiving rules. It is not a required field.

Filters - This parameter allows filtering for specific file extensions. This parameter can be null. If so, the following default is used: "*.*" - which means that the rule applies to all types of files.

Note: This parameter is only for Files and Folders, since Disk Image Standard uses volumes, not files.

Disk Usage Archiving Parameters

The following parameters are used for disk storage.

• Size - allowed values are between 1 and 9999.
• Unit - allowed units are Kilobyte, Megabyte, Gigabyte (this matches the SilverWind UI).

Example – Files and Folders

The following json example is defined as:

• Keep as many versions as possible using no more than 100 MB. Apply this rule to *.docx files.
• Keep as many versions as possible using no more than 250 MB. Apply this rule to *.docx files.

Age Archiving Parameters

The following parameters are used for archiving by age.

• Days - allowed ranges are between 1 and 999.
• MinimumRevisions - Allowed ranges are between 1 and 99.

Example – Files and Folders

The following Json example is defined as:

• Rule 1 - Keep at least 2 day(s) and no fewer than 5 version(s). Apply this rule to All files.
• Rule 2 - Keep at least 3 day(s) and no fewer than 6 version(s). Apply this rule to All files.

Versions Archiving Parameters

The number of versions allowed are values between 1 and 99.

Example– Files and Folders

DateRange Archiving Parameters

MinimumRevisions - number of revisions to keep, between 1 and 99.

• Ranges array - a maximum of 3 elements are allowed.
• Duration (between 1 and 99).
• Unit (Day, Week, Month, Year, Forever). In case of Forever, this always needs to be last in the Ranges array.
• Restrictions on ranges - these match restrictions in SilverWind's Web Monitor UI.

¾     Unit(range "i") <= Unit( range "i+j"). For example, you cannot have 2 ranges where the first is Weeks and the second one is Days, instead the second one needs to be weeks, years or forever. Or, if the second range is in months, the first range can only be days or weeks.

¾     if range "i" and range "i+j" have the same unit, then the following condition must be met: Duration (range "i+j") > Duration (range "i"). For example, if the first range is one year, the second one can only be 2 years or more.

¾     where j>=1, j<=n-i and n is the number of ranges

Example – Files and Folders

The following Json example is defined as:

• First rule: Keep all versions from now to 1 Day(s). After 1 Day(s), keep Daily versions for 2 Week(s). After 2 Week(s), keep Weekly versions forever. Keep no fewer than 10 version(s). Apply this rule to All files.
• Second rule: Keep all versions from now to 2 Month(s). After 2 Month(s), keep Monthly versions for 3 Year(s). After 3 Year(s), keep Yearly versions forever. Keep no fewer than 8 version(s). Apply this rule to All files.