ListPolicyGroups (v1,v2)

July 21, 2025

This API can be used to retrieve the group policy settings of a backup user.

The settings can be found on the AhsayCBS web console at:

  • Backup / Restore > Users, Groups & Policies > Policy Group

v1 ListPolicyGroups.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListPolicyGroups.do

Deprecated Since Version: 7.15.6.38

v2 ListPolicyGroups.do

For features related to Quota Management, administrator needs to utilize v2 ListPolicyGroups.do

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/ListPolicyGroups.do

Available Since Version: 9.7

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Username of the backup user.
PolicyGroupNameOnly Boolean Optional parameter can be true / false, default value is false.
Return Values
Key Type Description
Status String "OK" or "Error"
Data Array (data of NameInfo or PolicyGroup) If parameter PolicyGroupNameOnly is true, only data under NameInfo is returned. Otherwise, PolicyGroup is returned.
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, will only be displayed if the status is "Error".
JSON Objects

NameInfo

Key Type Description
PolicyGroupID String ID of the policy group.
PolicyGroupName String Name of the policy group.

PolicyGroup

Key Type Description
PreemptedValues Array Array for the preempted values of the policy group.
Type String The value can be one of the following: BACKUP_USER or SYSTEM_USER.
Owner String System user that owns the policy group.
GuiSettings Array Array for the GUI settings of the policy group.
PreemptedBackupSetSettings Array Array for the preempted backup set settings of the policy group.
BackupSetSettings Array Array for the backup set settings of the policy group.
UserSettings Array Array for the user settings of the policy group.
MobileSettings Array Array for the mobile settings of the policy group.
DefaultValues Array Array for the default values of the policy group.
ID String ID of the policy group.
Name String Name of the policy group.
Other Parameters Under Policy Group

PreemptedValues

Key Type Description
VmwareSettingsList Array Array for VMware settings.
VolumeShadowCopySettingsList Array Array for Volume Shadow Copy settings.
AllowedIPSettingsList Array Array for Allowed IP settings.
FollowLinkSettingsList Array Array for Follow Link settings.
InFileDeltaSettingsList Array Array for In File Delta settings.
CompressionsSettingsList Array Array for Compression settings.
WinUserAuthSettingsList Array Array for Windows User Authentication settings.
FileSettingsList Array For use with v1 UpdatePolicyGroup.do only.
GranularRestoreSettingsList Array Array for Granular Restore settings.
OpenDirectSettingsList Array Array for OpenDirect settings.
MswindowsSystemStateSettingsList Array Array for MS Windows System State settings.
DestinationSettingsList Array Array for Destination settings.
BandwidthControlSettingsList Array Array for Bandwidth Control settings.
NameSettingsList Array Array for Name settings.
MySQLSettingsList Array Array for MySQL settings.
FilePermissionsSettingsList Array Array for File Permission settings.
RetentionPolicySettingsList Array Array for Retention Policy settings.
ShadowProtectSettingsList Array Array for ShadowProtect settings.
AdvancedSettingsList Array Array for Advanced settings.
CommandSettingsList Array Array for Command settings.
TemporaryDirectorySettingsList Array Array for Temporary Directory settings.
OracleSettingsList Array Array for Oracle settings.
LotusNotesSettingsList Array Array for Lotus Notes settings.
ReminderSettingsList Array Array for Reminder settings.
FilterSettingsList Array Array for Filter settings.
MswindowsSystemSettingsList Array Array for MS Windows System settings.
LotusDominoSettingsList Array Array for Lotus Domino settings.
ScheduleSettingsList Array Array for Schedule settings.
EncryptionSettingsList Array Array for Encryption settings.
ArchivedLogDeletionSettingsList Array Array for Archived Log Deletion settings.
CdpSettingsList Array Array for Continuous Data Protection settings.
SourceShortcutSettingsList Array Array for Source Shortcut settings.
MariaDBSettingsList Array Array for MariaDB settings.
RecycleBinSettingsList Array Array for Recycle Bin settings.
DeduplicationSettingsList Object Refer to DeduplicationSettingsList, list of Deduplication settings.
TiberoSettingsList Array Array for Tibero settings.
PostgreSQLSettingsList Array Array for PostgreSQL settings.

GranularRestoreSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

VmwareSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

VMwareSetting

Key Type Description
Host String Host IP for VMware.
Port String Port for VMware host.
Username String Login name for VMware host.
Password String Password to authenticate VMware host.
Sshport String SSH port used, default is 22.
Id String ID of VMware host.
Version String Version of VMware host.
AutoEnableCBT Boolean Automatically enabled Changed Block Tracking when AhsayOBM detects VDDK mode
AppliedValueSettings Array See AppliedValueSettings.

OpenDirectSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

AppliedValueSettings

Key Type Description
Id String ID of Applied Value.
Type String For DefaultValues, this value is “default”. For PreemptedValues, this value is “preempted”.
Mode String For DefaultValues, this value is empty. For PreemtedValues, this value can be one of the following: prepend, append and override.
Name String Name of Applied Value.
Os String This value can be empty, or one of the following: windows, mac and linux.
AppliedModuleIDList Array The string can be any of the following values: FILE, Cloud File, Lotus Domino, Lotus Notes, MariaDB, Microsoft Exchange Server, Microsoft Exchange Mail (MAPI), Microsoft SQL Server, Microsoft Windows Virtualization, Microsoft Windows System Backup, MySQL, Oracle Database Server, Shadow Protect Bare Metal, System State, VMware Virtualization, Office 365 Exchange Online, Tibero Database Server. If a string above is added to the array, that module is selected.
Version String

This value can be empty, or non-empty for specific modules.

For VMWare module, the value can be one of the following: APPVERSION_ESX_V2, APPVERSION_ESXI_V2, APPVERSION_VMSERVER1, APPVERSION_VMSERVER2, APPVERSION_WORKSTATION, APPVERSION_WORKSTATION8, APPVERSION_PLAYER, APPVERSION_FUSION, APPVERSION_FUSION5, APPVERSION_VCENTER_V2.

For Microsoft Exchange and Exchange Mail module, the value can be one of the following: 8 (For Microsoft Exchange Server 2007), 14 (For Microsoft Exchange Server 2010), 15 (For Microsoft Exchange Server 2013) and DAG13 (For Microsoft Exchange Server 2013 (Database Availability Group))

For Microsoft Hyper-V module, the value can be one of the following: Microsoft Hyper-V Server, Microsoft Hyper-V Server R2, Microsoft Hyper-V Server R2 (FailoverCluster), Microsoft Hyper-V Server 2012, Microsoft Hyper-V Server 2012 (FailoverCluster), Microsoft Hyper-V Server 2012 R2, Microsoft Hyper-V Server 2012 R2 (FailoverCluster).

VolumeShadowCopySettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

VolumeShadowCopySetting

Key Type Description
Enable Boolean True / False
Id Array Array list of settings.
AppliedValueSettings Array See AppliedValueSettings.

AllowedIPSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

AllowedIPSetting

Key Type Description
Id String ID of settings.
AllowedIPList Array Array list of Allowed IPs.
AppliedValueSettings Array See AppliedValueSettings.

AllowedIP

Key Type Description
Id String ID of Allowed IP.
StartIP String Starting IP address, i.e. "From".
EndIP String Ending IP address, i.e. "To".

SourceShortcutSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

FollowLinkSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

FollowLinkSetting

Key Type Description
Enable Boolean True / False
Id String ID of setting.
AppliedValueSettings Array See AppliedValueSettings.

InFileDeltaSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

InFileDeltaSetting

Key Type Description
Enable Boolean True / False
Id String ID of setting.
WeeklyInFileDeltaSchedule Array See WeeklyInFileDeltaSchedule.
MonthlyInFileDeltaSchedule Array See MonthlyInFileDeltaSchedule.
MinDeltaFileSize Long Minimum delta file size.
MaxNumOfDelta Long Maximum delta file size.
MaxDeltaRatio Long Maximum delta ratio.
DeltaBlockSize Long Value of block size.
DefaultDeltaType String Delta type.
AppliedValueSettings Array See AppliedValueSettings.

WeeklyInFileDeltaSchedule

Key Type Description
Day Array The array contains 7 strings, representing the delta type from Sunday to Saturday. The value of the strings can be one of the following: F (for full backup), D (for differential delta) and I (for incremental delta).

MonthlyInFileDeltaSchedule

Key Type Description
Date Long Shows the selected day of the month.
Criteria String The value can be one of the following: Weekday, Weekend, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.
Occurence String The value can be one of the following: First, Second, Third, Fourth and Last.
Month Array The array contains 12 strings, representing the delta type from January to December. The value of the strings can be one of the following: F (for full backup), D (for differential delta) and I (for incremental delta).

CompressionsSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.
OverwriteDefaultCompression Boolean

If True, overwrite default compression type to "Fast with optimization for local".

When the default compression type is "Fast" and:

  1. Destination of Run on Server backup set is AhsayCBS or,
  2. First destination of Run on Client backup set is local.

Only CompressionsSettingsList of DefaultValues has this parameter.

CommandSetting

Key Type Description
Id String ID of setting.
Type String The value can be empty or one of the following: GzipDefaultCompression (Normal), GzipBestSpeedCompression (Fast) and SnappyDefaultCompression (Fast with optimization for local).
AppliedValueSettings Array See AppliedValueSettings.

WinUserAuthSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

WinUserAuthSetting

Key Type Description
Id String ID of setting.
Domain String Domain name/host name for AhsayOBM/AhsayACB to access network location.
Password String Password to access domain.
Username String Username used to access domain.
AppliedValueSettings Array See AppliedValueSettings.

SourceShortcutSettingsList

Key Type Description
Version String Version of AhsayCBS where setting was made.
@class String com.ahsay.obx.cxp.cpf.policy.values.source.FileSettings com.ahsay.obx.cxp.cpf.policy.values.source.Office365SourceShortcutSettings
WindowsOutlook Boolean Backup source shortcut to Outlook. Applicable for File backup set only.
WindowsOutlookExpress Boolean Backup source shortcut to Outlook Express. Applicable for File backup set only.
WindowsDesktop Boolean Backup source shortcut to Desktop. Applicable for File backup set only.
WindowsFavourites Boolean Backup source shortcut to Favourites. Applicable for File backup set only.
WindowsMail Boolean Backup source shortcut to Windows Mail. Applicable for File backup set only.
WindowsMyDocuments Boolean Backup source shortcut to My Documents. Applicable for File backup set only.
WindowsLiveMail Boolean Backup source shortcut to Windows Live Mail. Applicable for File backup set only.
Destination Array Applicable for Microsoft 365 backup set only.
OneDrive Boolean Backup source shortcut to OneDrive. Applicable for Microsoft 365 backup set only.
PublicFolders Boolean Backup source shortcut to Microsoft 365 Public Folders. Applicable for Microsoft 365 backup set only.
SiteCollections Boolean Backup source shortcut to Microsoft 365 SharePoint Site Collections. Applicable for Microsoft 365 backup set only.
Outlook Boolean Backup source shortcut to Microsoft 365 Outlook. Applicable for Microsoft 365 backup set only.
RunOnServer Boolean Run on server option. Applicable for Microsoft 365 backup set only.
PersonalSites Boolean Backup source shortcut to Microsoft 365 SharePoint Personal Sites. Applicable for Microsoft 365 backup set only.
AppliedValueSettings Array See AppliedValueSettings.

MswindowsSystemStateSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

MswindowsSystemStateSetting

Key Type Description
Id String ID of the MS Windows System State setting. By default, a standard ‘Default’ setting will be in place should no custom setting be set.
Version String Version of AhsayCBS where setting was made.
BackupTarget String Temporary location for the system backup.
AppliedValueSettings Array See AppliedValueSettings.

DestinationSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

DestinationSetting

Key Type Description
Id String ID of the setting.
SystemDestinationIDList Array Array of System Destination IDs.
DestinationList Array Array list of Destinations.
SystemDestinationList Array Array list of System Destinations.
AppliedValueSettings Array See AppliedValueSettings.

Destination

Key Type Description
Id String ID of the setting.

BandwidthControlSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

BandwidthControlSetting

Key Type Description
Enable Boolean True / False
Id String ID of the setting.
BandwidthControlList Array List of existing Bandwidth controls.
Mode String The value can be one of the following: independent or share.
AppliedValueSettings Array See AppliedValueSettings.

BandwidthControlSetting

Key Type Description
Name String Name of the bandwidth control.
Id String ID of the setting.
StartDay Long Starting day of the bandwidth control, which may be one of the following: Sunday = 1, Monday = 2, Tuesday = 3, Wednesday = 4, Thursday = 5, Friday = 6 and Saturday = 7.
StartHour Long Starting hour of the bandwidth control. Range is between 0 and 23.
StartMinute Long Starting minute of the bandwidth control. Range is between 0 and 59.
EndDay Long Day when bandwidth control ends. Similar values as StartDay.
EndHour Long Ending hour of the bandwidth control. Range is between 0 and 23.
EndMinute Long Ending minute of the bandwidth control. Range is between 0 and 59.
MaxTransferRateInBitsPerSec Long Transfer rate per second. Can be measured in Kbit/s, Mbit/s and Gbit/s.

NameSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

NameSetting

Key Type Description
Id String ID of the setting.
Name String Name of the setting.
AppliedValueSettings Array See AppliedValueSettings.

MySQLSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

MySQLSetting

Key Type Description
Id String ID of the setting.
Host String Host of the MySQL server. Default is localhost.
Port String Listening port of MySQL server. Default is 3306.
Username String Login ID of the MySQL system account.
Password String Password of the MySQL system account.
MysqldumpPath String Path to the mysqldump file.
Version String AhsayCBS version where the setting was made.
AppliedValueSettings Array See AppliedValueSettings.

FilePermissionsSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

FilePermissionsSetting

Key Type Description
Enable Boolean ID of the setting.
Id String ID of the setting.
AppliedValueSettings Array See AppliedValueSettings.

RetentionPolicySettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

RetentionPolicySetting

Key Type Description
Id String ID of the setting.
Period Long Number of days or jobs until deleted files are removed.
OverlapSensitive Boolean True / False
AdvancedRetentionPolicyList Array List of all Advanced Retention Policies.
Type String The value can be one of the following: SIMPLE or ADVANCED.
Unit String The value can be one of the following: DAYS or JOBS.
AppliedValueSettings Array See AppliedValueSettings.

AdvancedRetentionPolicy

Key Type Description
Name String Name of the retention policy.
ReadOnly Boolean True / False
Id Long ID of the retention policy.
Type String The value can be one of the following: DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY or CUSTOM.
NumbersToKeep Integer Number of X where files are kept within the retention area, with X being the Type. For example, if X is set as Daily, and NumbersToKeep is set to 12, then files are kept for 12 Days, except for the Custom type, where the number will be set to 0. By default this is set to 1.
Day Integer Refers to the “Day” within each Month when setting the policy’s type to either Monthly, Quarterly, Yearly, or Custom.
Week Integer When type is Monthly, refers to the order of the week in a month.
Month Integer

When type is Quarterly, refers to the order of the month per quarter.

Below are the quarter divisions and the months they contain:

  • 1 - All first months of a quarter, i.e. January, April, July and October
  • 2 - All second months of a quarter, i.e. February, May, August and November
  • 3 - All third months of a quarter, i.e. March, June, September and December

When type is Yearly, month refers to the specific month in a year.

Year Integer Refers to the specified year when retention policy type is Custom.
DateType String It can be empty for daily or weekly retention policy, or one of the following: WEEK_OF_MONTH, WEEK_OF_YEAR or EXACT.
Sun, Mon, Tue, Wed, Thu, Fri, Sat Boolean For weekly custom retention policy.

ShadowProtectSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

ShadowProtectSetting

Key Type Description
Id String ID of the ShadowProtect setting.
EncryptionAlgorithm Long

Type of algorithm used to encrypt the image file in the temporary directory. This will be displayed as an integer ranging from 0 to 4.

The following are the algorithm that may be used:

  • 0 - No encryption
  • 2 - AES 128-bit (A balance between speed and security)
  • 3 - RCA 128-bit (Fastest, but least secure)
  • 4 - AES 256-bit (The most secure but slowest)
EncryptionPassword String Password used for encryption.
Version String AhsayCBS version where the setting was made.
InstallLocation String Path to the ShadowProtect image.
AppliedValueSettings Array See AppliedValueSettings.

AdvancedSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

AdvancedSetting

Key Type Description
Id String ID of the setting.
DeselectedSourceList Array List of deselected sources.
SelectedSourceList Array List of selected sources.
Enable Boolean True / False
AppliedValueSettings Array See AppliedValueSettings.

CommandSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

CommandSetting

Key Type Description
Id String ID of the setting.
PreCommandList Array List of pre-backup commands.
PostCommandList Array List of post-backup commands.
AppliedValueSettings Array See AppliedValueSettings.

Command

Key Type Description
Id String ID of the command setting.
Name String Name of the command setting.
Type String The value can be one of the following: pre (for Pre-command) or post (for Post-command).
Command String Pre or post backup command to be run.
WorkingDir String Directory or address where the backup command will be run.

TemporaryDirectorySettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

OracleSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

OracleSetting

Key Type Description
Id String ID of the Oracle setting.
Host String Host of the Oracle server. Default is 127.0.0.1 or localhost.
Port String Listening port of Oracle server. Default is 1521.
LoginID String ID used to login to Oracle. Default is system login.
Password String Password used to login to Oracle.
Sid String Oracle SID.
Version String AhsayCBS version where the Oracle setting was made.
AppliedValueSettings Array See AppliedValueSettings.

LotusNotesSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

LotusNotesSetting

Key Type Description
Id String ID of the setting.
NotesIniPath String Path to the Notes.ini file.
Version String AhsayCBS version where the setting was made.
AppliedValueSettings Array See AppliedValueSettings.

ReminderSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

ReminderSetting

Key Type Description
OfflineNotificationDay Long This setting is only applicable for v6 legacy backup users.
BackupIntervalHour Long Range is from 00 - 23.
OfflineBackupEnabled Boolean On / Off
OfflineBackupReminderComputerName String The computer name for the offline backup reminder.
BackupIntervalDays Long Range is from 00 - 31.
ShowOfflineBackupReminder Boolean True / False
LogoutBackupReminderEnabled Boolean On / Off
LogoutBackupReminderComputerName String The computer name for the logout backup reminder.
Id String ID of the setting.
AppliedValueSettings Array See AppliedValueSettings.

FilterSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

FilterSetting

Key Type Description
Enable Boolean True / False
Id String ID of the setting.
FilterList Array See Filter.
AppliedValueSettings Array See AppliedValueSettings.

Filter

Key Type Description
Name String Name of the filter.
PatternList Array List of patterns.
ApplyToDir Boolean Apply filters to directory.
ApplyToFile Boolean Apply filters to file.
TopDir String Apply filter to specific directory only.
Type String The value can be one of the following: START_WITH, END_WITH, CONTAIN or CUSTOM.
MatchPatternAgainstFulPathOnly Boolean Matches pattern to full path.
Include Boolean Exclude or include the matched files/folders under top directory.
Only Boolean If set to true, will not include all unmatched files/folders. If set to false, will include all unmatched files/folders.

Pattern

Key Type Description
Pattern String Pattern used for the filter.

MswindowsSystemSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

MswindowsSystemSetting

Key Type Description
Id String ID of the setting.
Version String Versio of AhsayCBS when the setting was made.
BackupTarget String Temporary storage location of the MS Windows System.
AppliedValueSettings Array See AppliedValueSettings.

LotusDominoSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

LotusDominoSetting

Key Type Description
Id String ID of the setting.
Version String Version of AhsayCBS when the setting was made.
NotesIniPath String Path to the notes.ini file.
AppliedValueSettings Array See AppliedValueSettings.

TiberoSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

TiberoSetting

Key Type Description
Id String ID of the setting.
Host String Hostname or IP of the Tibero Database Server.
Port String Port used by Tibero Database Server. Default is 8629.
LoginID String ID used to login to Tibero Database Server.
Password String Password used to login to Tibero Database Server.
Sid String Tibero Database Server SID.
Version String Version of AhsayCBS when the setting was made.
AppliedValueSettings Array See AppliedValueSettings.

ScheduleSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

ScheduleSetting

Key Type Description
Id String ID of the setting.
Enable Boolean True / False
ComputerName String Name of the computer.
DailyScheduleList Array List of all Daily Schedules.
WeeklyScheduleList Array List of all Weekly Schedules.
MonthlyScheduleList Array List of all Monthly Schedules.
CustomScheduleList Array List of all Custom Schedules.
AppliedValueSettings Array See AppliedValueSettings.

DailyScheduleList

Key Type Description
ReadOnly Boolean True / False
Name String Name of the setting.
Id Long ID of the setting.
Hour Integer Referred to as HH. It is the schedule when the backup will start (HH:MM).
Minute Integer Referred to as MM. It is the schedule when the backup will start (HH:MM).
Duration Integer (optional) If no value is specified, default value = -1. The value can be one of the following: until full backup completed = -1 or stop backup after xx hours = 1 to 24.
BackupType String

The value can be empty or one of the following: DATABASE, DIFFERENTIAL, LOG, SKIP or POWEROFF.

For Oracle and Lotus Domino backup sets, the value must be DATABASE or LOG

For MS SQL Server backup sets, the value must be DATABASE or DIFFERENTIAL.

For MS Exchange Server before 2007 and Shadow Protect backup sets, the value must be DATABASE, DIFFERENTIAL, or LOG.

For MS Exchange Server 2007 or above, the value must be DATABASE or LOG.

For VMware backup sets, if version is VMware Server 1 or VMware Player, the value must be SKIP or POWEROFF.

SpaceFreeUpEnabled Boolean Remove obsolete files according to retention policy from backup destination according to retention policy.
LastUpdateTime Long Last time of update.
@class String com.ahsay.obx.cxp.obs.DailySchedule
BackupInterval Integer Support periodic schedule backup for all backup set types. The value can be -1 or one of the following: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120, 180, 240, 360, 480 or 720. (-1 means periodic schedule is disabled that it is a normal schedule)

WeeklyScheduleList

Key Type Description
ReadOnly Boolean True / False
Name String Name of the setting.
Id Long ID of the setting.
Hour Integer Referred to as HH. It is the schedule when the backup will start (HH:MM).
Minute Integer Referred to as MM. It is the schedule when the backup will start (HH:MM).
BackupType String Refer to BackupType of DailySchedule.
Duration Integer (optional) If no value is specified, default value = -1. The value can be one of the following: until full backup completed = -1 or stop backup after xx hours = 1 to 24.
Days Array The array contains 7 boolean values that corresponds to Sunday to Saturday. If the boolean value is true, the backup will run on that day.
SpaceFreeUpEnabled Boolean Remove obsolete files according to retention policy from backup destination according to retention policy.
LastUpdateTime Long Last time of update.
@class String com.ahsay.obx.cxp.obs.WeeklySchedule
BackupInterval Integer Support periodic schedule backup for all backup set types. The value can be -1 or one of the following: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120, 180, 240, 360, 480 or 720. (-1 means periodic schedule is disabled that it is a normal schedule)

MonthlyScheduleList

Key Type Description
ReadOnly Boolean True / False
Name String Name of the setting.
Id Long ID of the setting.
Hour Integer Referred to as HH. It is the schedule when the backup will start (HH:MM).
Minute Integer Referred to as MM. It is the schedule when the backup will start (HH:MM).
BackupType String Refer to BackupType of DailySchedule.
Duration Integer (optional) If no value is specified, default value = -1. The value can be one of the following: until full backup completed = -1 or stop backup after xx hours = 1 to 24.
Occurence String The value can be one of the following: First, Second, Third, Fourth or Last.
Criteria String The value can be one of the following: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Weekday or Weekend.
SpaceFreeUpEnabled Boolean Remove obsolete files according to retention policy from backup destination according to retention policy.
LastUpdateTime Long Last time of update.
@class String com.ahsay.obx.cxp.obs.MonthlySchedule

CustomScheduleList

Key Type Description
ReadOnly Boolean True / False
Name String Name of the setting.
Id Long ID of the setting.
Hour Integer Referred to as HH. It is the schedule when the backup will start (HH:MM).
Minute Integer Referred to as MM. It is the schedule when the backup will start (HH:MM).
Duration Integer (optional) If no value is specified, default value = -1. The value can be one of the following: until full backup completed = -1 or stop backup after xx hours = 1 to 24.
Date String In yyyy-MM-dd format.
BackupType String Refer to BackupType of DailySchedule.
SpaceFreeUpEnabled Boolean Remove obsolete files according to retention policy from backup destination according to retention policy.
LastUpdateTime Long Last time of update.
@class String com.ahsay.obx.cxp.obs.CustomSchedule

EncryptionSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

EncryptionSetting

Key Type Description
KeyLength Long Length of encryption key.
Key String Encryption key.
Type String Can be one of the following: DEFAULT, USER PASSWORD or CUSTOM.
Algorithm String Type of encryption used (Twofish, DESede, AES).
Mode String Can be one of the following: ECB or CBC.
Id String ID of the setting.
AppliedValueSettings Array See AppliedValueSettings.

ArchivedLogDeletionSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

ArchivedLogDeletionSetting

Key Type Description
Id String ID of the setting.
Enable Boolean True / False
Days Long Number of days.
AppliedValueSettings Array See AppliedValueSettings.

CdpSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

CdpSetting

Key Type Description
Enable Boolean True / False
Id String ID of the setting.
Type String

For version 6, the value can be one of the following: all-volume, backup-source or custom-source.

For version 8+, the value is all-volume

BackupType String

The value can be empty or one of the following: DATABASE, DIFFERENTIAL, LOG, SKIP or POWEROFF.

For Oracle and Lotus Domino backup sets, the value must be DATABASE or LOG

For MS SQL Server backup sets, the value must be DATABASE or DIFFERENTIAL.

For MS Exchange Server 2007 or above, the value must be DATABASE or LOG.

For VMware backup sets, if version is VMware Server 1 or VMware Player, the value must be SKIP or POWEROFF.

MinUpdateInterval Long Minimum frequency of updates.
TimeMarkInterval Long Set frequency of automatic backup job run.
MaxFileSize Long Maximum file size CDO setting applies to.
ComputerName String Name of the computer.
ExcludeSystemFiles Boolean Do not backup system files.
FilterList Array List of filters.
CdpBackupControlSettings Array See CDPBackupControl.
Version String The value can be one of the following: 6, 7 or 8.
SelectedSourceList Array Array of selected sources.
AppliedValueSettings Array See AppliedValueSettings.

CdpBackupControl

Key Type Description
ConsiderCpuUsage Boolean This setting is only applicable for v6 legacy backup users.
CpuUsage Integer This setting is only applicable for v6 legacy backup users.
ConsiderInput Boolean This setting is only applicable for v6 legacy backup users.
ObserveInputForSecond Integer This setting is only applicable for v6 legacy backup users.
ConsiderNetworkTraffic Boolean This setting is only applicable for v6 legacy backup users.
NetworkTraffic Long This setting is only applicable for v6 legacy backup users.

RecycleBinSettingsList

Key Type Description
Enable Boolean True / False
List Array Array list of settings.

RecycleBinSetting

Key Type Description
AppliedValueSettings Array See AppliedValueSettings.
Enable Boolean Enable moving the files to the Recycle Bin when remove file from Retention Policy or DIC
RetentionPeriod Integer Number of days files will be kept in the recycle bin.

UserSettings

Key Type Description
MaximumBackupSetsSettings Array Array setting of maximum amount of backup sets.
HostLimitSettings Array Array list of maximum number of hosts.
RunDirectLimitSettings Array Array list of maximum number of VMs.
AdvertisementSettings Array Array list of advertisement settings.
BackupDestinationSettings Array For v2 ListPolicyGroups.do, the EnableQuota and Quota parameters have been removed from this JSON object. They will be displayed under the UserQuotaSettings JSON object.
LogonSettings Array Settings for login.
EncryptionKeySettings Array Array list of encryption key settings.
EmailReportSettings Array Array list of email report settings.
UserQuotaSettings Array Array list of quotas for users.
QuotaSettings Array Array list of quotas settings.
CloudBackupSourceSettings Array Array list of cloud backup source settings.
PasswordSettings Array Array list of password settings.
SharedQuotaSettings Array Array list of shared quota settings.

MaximumBackupSetsSettings

Key Type Description
Enable Boolean True / False
MaximumBackupSetsPerUser Long Maximum amount of allowable backup sets that can be created by user.

HostLimitSettings

Key Type Description
Enable Boolean True / False
MaxHost Long Maximum number of hosts per user.

RunDirectLimitSettings

Key Type Description
Enable Boolean True / False
MaxVm Long Maximum number of VMs per user.

AdvertisementSettings

Key Type Description
Enable Boolean True / False
AdvertisementList Array Array list of advertising options/settings.

BackupDestinationSettings

Key Type Description
ApplicationName String Name of application.
CustomDestinationList Array Array list of custom destinations.
SystemDestIDList Array Array list of destination IDs.
SystemDestinationList Array Array list of system destinations.

CustomDestinationList (BackupDestinationSettings)

Key Type Description
Name String Name of the destination.
@class String

The value can be one of the following:

  • com.ahsay.obx.cxp.cpf.policy.userSettings.LocalDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.AmazonS3Destination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.AWSCompatibleDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.GoogleCloudStorageDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.GoogleDriveDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.PooledDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.WindowsAzureDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.OneDriveDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.OneDrive4BizDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.RackspaceDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.OpenStackDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.DropboxDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.FtpDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.SftpDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.ObsDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.AliyunDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.BackblazeDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.WasabiDestination
Enable Boolean True / False
ApplicationSecret String For Dropbox only.
ClientID String For Google Drive destination, OneDrive, OneDrive for Business (Global and Germany region) only.
ChinaClientID String For OneDrive for Business (China region) only.
ClientSecret String For Google Drive destination and OneDrive only.
RedirectURI String For OneDrive and OneDrive for Business (Global and Germany region) only.
ChinaRedirectURI String For OneDrive for Business (China region) only.

LogonSettings

Key Type Description
Enable Boolean True / False
InvalidLoginAttemptPeriod Long Number of invalid login attempts.
BlockMinute Long Specified time period for invalid login attempt (minutes).
BlockHour Long Specified time period for invalid login attempt (hours).
NumOfInvalidLogin Long Number of invalid login attempts allowed within a specified time period.
BlockType String The value can be one of the following: MINUTE, HOUR or FOREVER.

EncryptionKeySettings

Key Type Description
Enable Boolean True / False
Upload Boolean True / False

EmailReportSettings

Key Type Description
Enable Boolean True / False
ConsolidatedReportSendMin Long Time (minute) consolidated e-mail report will be sent.
ConsolidatedReportSendHour Long Time (hour) consolidated e-mail report will be sent.
SendIndividualReport Boolean True / False, sends individual e-mail reports to users.
SendConsolidatedReport Boolean True / False, sends consolidated e-mail reports to users.
ContactList Array Array list of contacts.

UserQuotaSettings

Key Type Description
Enable Boolean True / False
QuotaList Array List of all quota settings.
QuotaType String Quota type, either TOTAL_QUOTA or PER_DESTINATION_QUOTA.
StorageQuota Long Total quota in GB.
DefaultMode Boolean True / False. If false, this means that “mode” has been set to “Preempted”.

QuotaList (UserQuotaSettings)

Key Type Description
Enable Boolean True / False
Quota Long Unit in byte.
DestinationName String Name of the backup destination.
DestinationKey String ID of the backup destination.

QuotaSettings

Key Type Description
Enable Boolean True / False
Compress Boolean True / False

CloudBackupSourceSettings

Key Type Description
Enable Boolean True / False
CloudSourceList Array Array list of cloud sources.

CloudSourceList (CloudBackupSourceSettings)

Key Type Description
Name String Name of the destination.
@class String

The value can be one of the following:

  • com.ahasy.obx.csp.cpf.policy.userSettings.AmazonS3Source
  • com.ahasy.obx.csp.cpf.policy.userSettings.AWSCompatibleSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.GoogleCloudStorageSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.GoogleDriveSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.WindowsAzureSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.OneDriveSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.OneDrive4BizSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.RackspaceSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.OpenStackSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.DropboxSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.FtpSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.SftpSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.AliyunSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.BackblazeSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.CTYunSource
  • com.ahasy.obx.csp.cpf.policy.userSettings.WasabiSource
  • com.ahsay.obx.cxp.cpf.policy.userSettings.LocalDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.AmazonS3Destination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.AWSCompatibleDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.GoogleCloudStorageDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.GoogleDriveDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.PooledDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.WindowsAzureDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.OneDriveDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.OneDrive4BizDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.RackspaceDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.OpenStackDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.DropboxDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.FtpDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.SftpDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.ObsDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.AliyunDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.BackblazeDestination
  • com.ahsay.obx.cxp.cpf.policy.userSettings.WasabiDestination
ApplicationSecret String For Dropbox only.
ClientID String For Google Drive destination, OneDrive, OneDrive for Business (Global and Germany region) only.
ChinaClientID String For OneDrive for Business (China region) only.
ClientSecret String For Google Drive destination and OneDrive only.
RedirectURI String For OneDrive and OneDrive for Business (Global and Germany region) only.
ChinaRedirectURI String For OneDrive for Business (China region) only.
BusinessApplicationKey String Application key of Dropbox for Business, for Dropbox only.
BusinessApplicationSecret String Application secret of Dropbox for Business, for Dropbox only.

PasswordSettings

Key Type Description
Enable Boolean True / False
Type String The value can be one of the following: DEFAULT or CUSTOM.
Number Boolean True / False
Lowercase Boolean True / False
MinimumLength Long Minimum length allowed for passwords.
EnforcePasswordHistory Boolean True / False
SpecialCharacters Boolean True / False
Uppercase Boolean True / False
PasswordAge Long Number of days password has been in use.
MinimumLengthEnabled Boolean True / False
Regex String Regular expression

SharedQuotaSettings

Key Type Description
Enable Boolean True / False
QuotaList Array Array list of quota settings.

QuotaList (SharedQuotaSettings)

Key Type Description
Enable Boolean True / False
MaxPercentage Long Maximum percentage of shared size for each user.
Quota Long Unit in byte.
DestinationName String Name of the backup destination.
DestinationKey String ID of the backup destination.

GuiSettings

Key Type Description
PrivilegeList Array Array list of settings.

Privilege

Key Type Description
Id String ID of the settings.
EnableRead Boolean True / False
EnableWrite Boolean If write privilege is not available for the privilege, this key is removed from the result
PrivilegeGroup String Name of the privilege group.
PolicyName String Name of the policy.
DisplayName String The name of privilege defined in properties.

PreemptedBackupSetSettings

Key Type Description
PreemptedBackupSetList Array Refer to BackupSet JSON Object in ListBackupSets API.

BackupSetSettings

Key Type Description
ExcludeFileSettings Array Array list of settings.

ExcludeFileSettings

Key Type Description
Enable Boolean True / False
LastModifiedPeriodType String The value can be "YEAR".
LastModifiedType String The value can be "PERIOD".
LastModifiedDate Long Date when the setting was last modified.
ExcludeFileSize Boolean True / False
ExcludeMappedDrive Boolean True / False
ExcludeLastModified Boolean True / False
FileSize Long Size of file.
LastModifiedPeriod Long Period when setting was last modified.

BackupSetTypeSettings

Key Type Description
Enable Boolean True / False
BackupSetTypeList Array Array list of settings.

DefaultValues

Key Type Description
VmwareSettingsList Array Array list; VMware settings.
VolumeShadowCopySettingsList Array Array list; Volume Shadow Copy settings.
AllowedIPSettingsList Array Array list; Allowed IP settings.
FollowLinkSettingsList Array Array list; Follow link settings.
InfileDeltaSettingsList Array Array list; In File Delta settings.
CompressionSettingsList Array Array list; Compression settings.
WinUserAuthSettingsList Array Array list; Windows User Authentication settings.
FileSettingsList Array For use with v1 UpdatePolicyGroup.do only.
GranularRestoreSettingsList Array Array list; Granular Restore settings.
OpenDirectSettingsList Array Array list; OpenDirect settings.
MswindowsSystemStateSettingsList Array Array list; Microsoft Windows System State settings.
DestinationSettingsList Array Array list; Destination settings.
BandwidthControlSettingsList Array Array list; Bandwidth Control settings.
NameSettingsList Array Array list; Name settings.
MySQLSettingsList Array Array list; MySQL settings.
FilePermissionsSettingsList Array Array list; File Permissions settings.
RetentionPolicySettingsList Array Array list; Retention Policy settings.
ShadowProtectSettingsList Array Array list; ShadowProtect settings.
AdvancedSettingsList Array Array list; Advanced settings.
CommandSettingsList Array Array list; Command settings.
TemporaryDirectorySettingsList Array Array list; Temporary Directory settings.
OracleSettingsList Array Array list; Oracle settings.
LotusNotesSettingsList Array Array list; Lotus Notes settings.
ReminderSettingsList Array Array list; Reminder settings.
FilterSettingsList Array Array list; Filter settings.
MswindowsSystemSettingsList Array Array list; Microsoft Windows System settings.
LotusDominoSettingsList Array Array list; Lotus Domino settings.
TiberoSettingsList Array Array list; Tibero settings.
ScheduleSettingsList Array Array list; Schedule settings.
EncryptionSettingsList Array Array list; Encryption settings.
ArchivedLogDeletionSettingsList Array Array list; Archived Log Deletion settings.
CdpSettingsList Array Array list; Continuous Data Protection settings.
SourceShortcutSettingsList Array Array list; Source shortcut settings.
MariaDBSettingsList Array Array list; MariaDB settings.
RecycleBinSettingsList Array Array list; Recycle bin settings.
DeduplicationSettingsList Array Array list; Deduplication settings.
PostgreSQLSettingsList Array Array list; PostgreSQL settings.

DeduplicationSettingsList

Key Type Description
Enable Boolean Enable or disable the list of Deduplication settings.
List Array Array of DeduplicationSettings (Policy).

Array - Deduplication Settings (Policy)

Key Type Description
Enabled Boolean Whether Deduplication is enabled.
@class String com.ahsay.obx.cxp.cpf.policy.values.deduplication.DeduplicationSettings
Scope String Either SAME_FILE or ALL_FILES, other values will result in error.
BlockSize Integer
  • 65536 for 64k-256k
  • 131072 for 128k-512k
  • 262144 for 256k-1M
  • 524288 for 512k-2M
  • 1048576 for 1M-4M

Removed in v9.5: -1 (was for "Auto" default choice in earlier v9).

SettingsMigrated Boolean Whether the settings will be migrated from In-File Delta settings in next profile update.
MigrateData Boolean Whether to migrate data for pre-v9 In-File Delta to v9 Deduplication when backed up.
AppliedValueSettings Object AppliedValueSettings object, apply the setting to which module(s).

LoginWebConsoleSettings

Key Type Description
Enable Boolean True = policy applies.
AllowWebConsoleLogin Boolean True = allow backup user to login to AhsayCBS web console.
Example

Example 1

INPUT

{
	"SysUser":"api",
	"SysPwd":"abc123",
	"LoginName":"username",
	"PolicyGroupNameOnly":true
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"PolicyGroupName":"Default settings",
			"PolicyGroupID":"2"
		}
	]
}

Example 2 - Snippet Example (Deduplication)

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"LoginName":"username"
}

OUTPUT

{
	
	
“@class”:”com.ahsay.obx.cxp.cpd.policy.values.deduplication.Deduplication
Settings”,
		"MigrateData":false,
		"AppliedValueSettings":{
			"Type":"default",
			"@class":"com.ahsay.obx.cxp.cpf.policy.values.AppliedValueSettings",
			"Os":"",
			"Version":"",
			"Mode":"",
			"BackupMode":"",
			"AppliedModuleSettingsList":[
			{
				"Enable":false,
				"Name":"FILE"
			},
			{
				"Enable":false,
				"Name":"Lotus Domino"
			},
			{
				"Enable":false,
				"Name":"Notes"
			},
			{
				"Enable":false,
				"Name":"Microsoft Exchange Server"
			},
			{
				"Enable":false,
				"Name":"Microsoft Exchange Mail (MAPI)"
			},
			{
				"Enable":false,
				"Name":"Microsoft SQL Server"
			},
			{
				"Enable":true,
				"Name":"Microsoft Windows Virtualization"
			},
			{
				"Enable":false,
				"Name":"Microsoft Windows System Backup"
			},
			{
				"Enable":false,
				"Name":"MySQL"
			},
			{
				"Enable":false,
				"Name":"MariaDB"
			},
			{
				"Enable":false,
				"Name":"Oracle Database Server"
			},
			{
				"Enable":false,
				"Name":"ShadowProtect Bare Metal"
			},
			{
				"Enable":false,
				"Name":"System State"
			},
			{
				"Enable":true,
				"Name":"VMware Virtualization"
			},
			{
				"Enable":false,
				"Name":"Cloud File"
			},
			{
				"Enable":false,
				"Name":"Office 365 Exchange Online"
			}
		],
		"Id":"1434946034923",
		"Name":"Default deduplication settings - VMware & Hyper-V"
		},
		"Scope":"ALL_FILES",
		"Enabled":true,
		"SettingsMigrated":true,
		"BlockSize":524288
...	
}

Example 3 - Snippet Example (RecycleBinSettingsList)

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"LoginName":"username",
	"ID":"1692164125127"
}

OUTPUT

{
	"RecycleBinSettingsList":{
		"Enable":true,
		"List":[
		{
		
"@class”:”com.ahsay.obx.cxp.cpf.policy.values.others.RecycleBinSettings",
			"AppliedValueSettings":{
				"Destination":"".
				"Type":"default",
				
"@class”:”com.ahsay.obx.cxp.cpf.policy.values.AppliedValueSettings",
			"Os":"",
			"Version":"",
			"Mode":"",
			"BackupMode":"",
			"AppliedModuleSettingsList":[
			{
				"Enable":true,
				"Name":"FILE"
			},
			{
				"Enable":false,
				"Name":"Lotus Domino"
			},
			{
				"Enable":false,
				"Name":"Notes"
			},
			{
				"Enable":false,
				"Name":"Microsoft Exchange Server"
			},
			{
				"Enable":false,
				"Name":"Microsoft Exchange Mail (MAPI)"
			},
			{
				"Enable":false,
				"Name":"Microsoft SQL Server"
			},
			{
				"Enable":false,
				"Name":"Microsoft Windows Virtualization"
			},
			{
				"Enable":false,
				"Name":"Microsoft Windows System Backup"
			},
			{
				"Enable":false,
				"Name":"MySQL"
			},
			{
				"Enable":false,
				"Name":"MariaDB"
			},
			{
				"Enable":false,
				"Name":"Oracle Database Server"
			},
			{
				"Enable":false,
				"Name":"ShadowProtect Bare Metal"
			},
			{
				"Enable":false,
				"Name":"System State"
			},
			{
				"Enable":false,
				"Name":"VMware Virtualization"
			},
			{
				"Enable":false,
				"Name":"Cloud File"
			},
			{
				"Enable":false,
				"Name":"Office 365 Exchange Online"
			}
		],
		"Id":"1692164125127",
		"Name":"Setting1"
	},
	"Enabled":true,
	"RetentionPeriod":8
}
Documentation