Ahsay Cloud Backup Suite

API Guide
Version 9

Ahsay Systems Corporation Limited

16 April 2024

A wholly owned subsidiary of

Ahsay Backup Software Development Company Limited
www.ahsay.com HKEx Stock Code: 8290
Copyright Notice
© 2024 Ahsay Systems Corporation Limited. All rights reserved.

The use and copying of this product is subject to a license agreement. Any other use is prohibited. No part of this publication may be reproduced,
transmitted, transcribed, stored in a retrieval system or translated into any language in any form by any means without prior written consent of
Ahsay Systems Corporation Limited. Information in this manual is subject to change without notice and does not represent a co mmitment on the
part of the vendor, Ahsay Systems Corporation Limited does not warrant that this document is error free. If you find any erro rs in this document,
please report to Ahsay Systems Corporation Limited in writing.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

Trademarks
Ahsay, Ahsay Cloud Backup Suite, Ahsay Online Backup Suite, Ahsay Offsite Backup Server, Ahsay Online Backup Manager, Ahsay A -Click Backup,
Ahsay Replication Server, Ahsay BackupBox Firmware, Ahsay Universal Backup System and Ahsay NAS Client Utility, Ahsay Mobile are trademar ks
of Ahsay Systems Corporation Limited.
Amazon S3 is a registered trademark of Amazon Web Services, Inc., or its affiliates.
Apple and Mac OS X, macOS, and iOS are registered trademarks of Apple Computer, Inc.
Dropbox is a registered trademark of Dropbox Inc.
Google Cloud Storage, Google Drive, Google Authenticator, and Android are registered trademarks of Google Inc.
Wasabi Hot Cloud Storage is a registered trademark of Wasabi Technologies Inc.
Backblaze B2 Cloud Storage is a registered trademark of Backblaze Inc.
MariaDB is a registered trademark of MariaDB Corporation AB.
Lotus, Domino, and Notes are registered trademark of IBM Corporation.
Microsoft Windows, Microsoft Exchange Server, Microsoft SQL Server, Microsoft Hyper-V, Microsoft Azure, OneDrive, OneDrive for Business,
Microsoft Authenticator, and Microsoft Office 365 are registered trademarks of Microsoft Corporation.
Oracle, Oracle Database, Java and MySQL are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their
respective owners.
OpenJDK is a registered trademark of Oracle America, Inc.
Rackspace and OpenStack are registered trademarks of Rackspace US, Inc.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo and JBoss are registered trademarks of Red Hat, Inc. www.redhat.com in the U.S. and
other countries.
Linux is a registered trademark of Linus Torvalds in the U.S. and other countries.
Ubuntu is a registered trademark of Canonical Ltd.
Debian is a registered trademark of Software in the Public Interest, Inc.
Rocky is a registered trademark of Rocky Brands.
ShadowProtect is a registered trademark of StorageCraft Technology Corporation.
VMware ESXi, vCenter, and vSAN are registered trademarks of VMware, Inc.
Tibero is a registered trademark of TmaxData Co., Ltd.

All other product names are registered trademarks of their respective owners.

Disclaimer
Ahsay Systems Corporation Limited will not have or accept any liability, obligation or responsibility whatsoever for any loss , destruction or
damage (including without limitation consequential loss, destruction or damage) however arising from or in respect of any use or misuse of
reliance on this document. By reading and following the instructions in this document, you agree to accept unconditionally th e terms of this
Disclaimer and as they may be revised and/or amended from time to time by Ahsay Systems Corporation Limited without prior notice to you.

www.ahsay.com
Revision History
Date Description Version
05 September 2023 ▪ Added Return Values for Deduplication (DedupeEnabled, 9.7
DedupeOriginalSize, DedupeSaving) to
GetBackupJobReport and GetBackupJobReportSummary
API.
▪ Added TotalStatistics JSON Object to GetUser API
▪ Added RecycleBinSettingsList JSON Object (Preempted
Value, table) to ListPolicyGroups API
▪ Added RecycleBinSettings JSON Object table to
UpdateBackupSet API
▪ Added ModuleUsage JSON Object table to GetBackupSet
API
▪ Added ModuleUsage JSON Object table to GetUser API
▪ Added ModuleUsage JSON Object table to ListBackupSets
API
▪ Added ModuleUsage JSON Object table to ListUsers API

12 October 2023 ▪ Updated “BackupType” parameter for AddSchedule, 9.7

UpdateSchedule, and RunBackup APIs

16 April 2024 ▪ Added new Parameters for Linux Bare Metal support to 9.9
AddBackupSet, AddUser, UpdateSystemSetting, and
UpdateUser APIs
▪ Added new APIs GetRestoreDrillJobReportSummary and
ListRestoreDrillJobs under Report section
▪ Added application keys for Dropbox for Business to
ListPolicyGroups and UpdatePolicyGroup APIs
▪ Added new Parameters for Tibero Database Server support
to AddBackupSet, AddUser, GetBackupSet,
GetSystemSetting, ListUsers, RunBackup,
UpdateBackupSet, UpdateSystemSetting, and UpdateUser
APIs
▪ Added parameters and new section tables to
ListPolicyGroups and UpdatePolicyGroup for Tibero
Database Server support
▪ Updated ReportSettingsBean section for GetSystemSetting
and UpdateConfig APIs

www.ahsay.com
TABLE OF CONTENTS
1 INTRODUCTION ............................................................................................................................................... 1
1.1 OVERVIEW........................................................................................................................................... 2
1.2 LIMITATIONS AND RECOMMENDATIONS............................................................................................. 3
1.3 API ACCESS ACCOUNT TYPES ............................................................................................................... 4
READ-ONLY API USER .......................................................................................................................... 4
1.4 2FA ONE-TIME PASSCODE PARAMETER ............................................................................................... 6
1.5 IP RESTRICTIONS.................................................................................................................................. 7
1.6 TROUBLESHOOTING ............................................................................................................................ 9
ERRONEOUS CHARACTERS (TRAILING SPACES) .................................................................................... 9
SYNTAX ERRORS .................................................................................................................................. 9
PARAMETER NAMES TYPO ERRORS ................................................................................................... 11
EXTRA KEY INPUTS ............................................................................................................................. 11
ESCAPE CHARACTER ERRORS ............................................................................................................. 12
INCORRECT API URL PATH ................................................................................................................. 12
2 SYSTEM API ................................................................................................................................................... 14
2.1 SYSTEM ............................................................................................................................................. 15
GETBUILDINGSTATUS ........................................................................................................................ 15
GETDATAMIGRATIONPROGRESS........................................................................................................ 18
GETREPLICATIONSTATUS ................................................................................................................... 20
GETSYSTEMSTATUS ........................................................................................................................... 25
2.2 SYSTEM CONFIG ................................................................................................................................ 33
UPDATESERVERCONFIG (V1), UPDATESYSTEMSETTINGS (V2) – BACKUP SERVER ............................... 33
UPDATECONFIG – BACKUP SERVER .................................................................................................... 39
GETSYSTEMSETTING (V1, V2) – BACKUP SERVER ............................................................................... 45
UPDATEREPLICATIONCONFIG ............................................................................................................ 53
UPDATELICENSE ................................................................................................................................ 57
GETLICENSE (v1, v2) ........................................................................................................................... 59
GETREPLICATIONMODE ..................................................................................................................... 65
ADDPREDEFINEDDESTINATION .......................................................................................................... 67
2.3 SYSTEM USER .................................................................................................................................... 82
ADDSYSUSER ..................................................................................................................................... 82
UPDATESYSUSER ............................................................................................................................... 86

www.ahsay.com
 REMOVESYSUSER .............................................................................................................................. 90
AUTHSYSTEMUSER ............................................................................................................................ 92
LISTSYSTEMUSERS ............................................................................................................................. 94
2.4 GROUP POLICY .................................................................................................................................. 97
ADDUSERGROUP ............................................................................................................................... 97
DELETEPOLICYGROUP ...................................................................................................................... 100
DELETEPOLICYGROUPFROMUSERGROUP ........................................................................................ 101
DELETEUSERFROMUSERGROUP ....................................................................................................... 103
DELETEUSERGROUP ......................................................................................................................... 105
LISTPOLICYGROUPS (V1, V2) ............................................................................................................ 107
LISTUSERGROUPS ............................................................................................................................ 150
MODIFYUSERGROUP ....................................................................................................................... 153
UPDATEPOLICYGROUP (V1, V2) ....................................................................................................... 155
ADDPOLICYGROUP .......................................................................................................................... 185
ADDPOLICYGROUPTOUSERGROUP .................................................................................................. 189
3 USER API...................................................................................................................................................... 193
3.1 USER ............................................................................................................................................... 193
LISTUSERS (V1, V2) .......................................................................................................................... 193
AUTHUSER ....................................................................................................................................... 202
RUNSINGLEUSERREBUILD ................................................................................................................ 204
GETSINGLEUSERREBUILDSTATUS ..................................................................................................... 206
GETUSERSTORAGESTAT ................................................................................................................... 208
UPDATEUSERPROFILE (V1), UPDATEUSER (V2) ................................................................................ 213
ADDCONTACT .................................................................................................................................. 227
ADDUSER (v1, v2) ............................................................................................................................ 229
GETUSER (V1, V2) ............................................................................................................................ 236
MODIFYUSERSTATUS ....................................................................................................................... 254
REMOVEUSER .................................................................................................................................. 256
SENDFORGOTPWDEMAIL ................................................................................................................ 257
GETUSERSTATUS ............................................................................................................................. 259
GETSERVERRUNJOBSTATUS ............................................................................................................. 266
UPDATEAUA .................................................................................................................................... 268
3.2 BACKUP SET .................................................................................................................................... 271
UPDATEBACKUPSET (V1, V2) ........................................................................................................... 271

www.ahsay.com
 ADDSELECTSRC ................................................................................................................................ 303
REMOVESELECTSRC ......................................................................................................................... 306
ADDDESELECTSRC ............................................................................................................................ 308
REMOVEDESELECTSRC ..................................................................................................................... 311
ADDSCHEDULE (V1,V2) .................................................................................................................... 313
UPDATESCHEDULE (V1, V2) ............................................................................................................. 320
REMOVESCHEDULE.......................................................................................................................... 326
ADDFILTER ....................................................................................................................................... 328
UPDATEFILTER ................................................................................................................................. 330
REMOVEFILTER ................................................................................................................................ 333
REMOVEBANDWIDTHCONTROL ....................................................................................................... 335
ADDBACKUPSET............................................................................................................................... 337
ADDALLOWEDIP .............................................................................................................................. 345
REMOVEALLOWEDIP ....................................................................................................................... 347
DELETEBACKUPDATA ....................................................................................................................... 349
DELETEBACKUPFILE ......................................................................................................................... 350
DELETEBACKUPSET .......................................................................................................................... 351
GETBACKUPJOBPROGRESS .............................................................................................................. 354
GETBACKUPSET (V1, V2) .................................................................................................................. 357
LISTBACKUPFILES ............................................................................................................................. 372
LISTBACKUPJOBMODE ..................................................................................................................... 375
LISTBACKUPJOBS ............................................................................................................................. 377
LISTBACKUPJOBSTATUS ................................................................................................................... 379
LISTBACKUPSETS.............................................................................................................................. 382
RUNBACKUP .................................................................................................................................... 386
ADDPRECOMMAND ......................................................................................................................... 389
UPDATEPRECOMMAND ................................................................................................................... 391
REMOVEPRECOMMAND .................................................................................................................. 394
ADDPOSTCOMMAND ...................................................................................................................... 396
UPDATEPOSTCOMMAND ................................................................................................................. 398
REMOVEPOSTCOMMAND................................................................................................................ 401
LISTRESTOREJOBS ............................................................................................................................ 402
LISTRESTOREJOBSTATUS .................................................................................................................. 404
LISTRESTOREDRILLJOBS ................................................................................................................... 407

www.ahsay.com
 3.3 REPORT ........................................................................................................................................... 409
GETBACKUPJOBREPORT................................................................................................................... 409
GETBACKUPJOBREPORTSUMMARY.................................................................................................. 415
GETRESTOREJOBREPORT ................................................................................................................. 418
GETRESTOREDRILLJOBREPORTSUMMARY........................................................................................ 422
4 RPS API ........................................................................................................................................................ 426
4.1 RPS RECEIVER .................................................................................................................................. 426
LISTRECEIVER ................................................................................................................................... 426
UPDATERECEIVERS .......................................................................................................................... 431
REMOVERECEIVER ........................................................................................................................... 436
5 RDR API ....................................................................................................................................................... 438
5.1 RDR LICENSE .................................................................................................................................... 438
UPDATELICENSE .............................................................................................................................. 438
5.2 SERVER CONFIG ............................................................................................................................... 440
UPDATESERVERCONFIG ................................................................................................................... 440
CONTACT AHSAY .................................................................................................................................................. 443
SUPPORT ..................................................................................................................................................... 443
DOCUMENTATION ....................................................................................................................................... 443
APPENDIX – OVERVIEW ....................................................................................................................................... 444
CONVENTIONS ............................................................................................................................................. 444
DEFINITIONS, ACRONYMS, AND ABBREVIATIONS ......................................................................................... 445
SUPPORTED LANGUAGE CODE ..................................................................................................................... 446
SUPPORTED TIMEZONES .............................................................................................................................. 447

www.ahsay.com
1 INTRODUCTION
AhsayCBS contains a set of APIs (Application Programming Interface), which allows you to
integrate your own or external applications (e.g. billing system or automated registration
system) with AhsayCBS.

This guide will mainly discuss how to invoke API requests with sample Inputs and Outputs for
the specific API being discussed.

For clarity, the specific focuses of this guide are:

API Categories and the specific APIs under each

API URLs

Version availability for each API

API Parameters

Return Values

JSON Objects

Terms and abbreviations used

www.ahsay.com AhsayCBS API Guide | 1 of 450

1.1 OVERVIEW
AhsayCBS comes with a set of REST APIs which is JSON (JavaScript Object Notation) based
JavaScript syntax. It can be read and used as a data format by any programming language (Java,
Python, PHP, C, cURL, etc.) to develop your own custom application or reporting tool.

API request can be invoked by using POST method only.

NOTE
All examples as shown for the discussed APIs in future chapters are all based on the latest API versions (V2).

Here is a sample of the JSON request input:

{
“SysUser”:”APluser”,
“SysPwd”:”my_password”,
“Hostname”:”mybackup.com”,
…
:
:
:
}

NOTE
For further reference on the JSON syntax or documentation, please refer to:
JSON - Introduction
What is JSON?
More examples are available in the following API sections.

www.ahsay.com AhsayCBS API Guide | 2 of 450

1.2 LIMITATIONS AND RECOMMENDATIONS
For backwards compatibility, AhsayCBS version 9 supports the use of some APIs from legacy
version 6 (API in XML format). However, your results may vary, and it is recommended for
programmers to change all existing legacy coding with the use of the JSON syntax API in relation
to the support of new features in version 9.

New features introduced in AhsayCBS version 9 will not be supported by APIs written and based
on Ahsay version 6 XML formatting. Continued use of the XML API may yield unexpected
results.

If you run multiple AhsayCBS servers with varying AhsayCBS versions (i.e. CBS v7.17, v8.5, and
v9.1 in your environment), when developing your own application that calls Ahsay API requests,
we suggest you use API to check the AhsayCBS version, then call the corresponding API request
for that AhsayCBS version.

With some API methods, there may be two versions: “v1” and “v2”. For features related to
Quota Management, v2 was produced to handle these features initially introduced in AhsayCBS
v7.15.6.38. If your AhsayCBS is higher than this version, you should already be using V2 API. If
your application is requesting data from AhsayCBS v7.15.6.38 or earlier, then continue to use
V1 API.

There may be other enhancements which have deprecated other API, for example
“GetLicense.do” in AhsayCBS v8.3.

Additional details for limitations and recommendations include:

Coding for your application must support UTF-8.

When testing your API, ensure that you have all parameters and / or settings setup on
your AhsayCBS.

Please arrange your test case in a logical sequence, such as creating a backup set before
attempting to Modify / Delete a backup set with API.

NOTE
This Ahsay v9 API Guide has removed the “v1” API methods deprecated by v7.15.6.38. For details regarding
“v1” API, please request older API Guide(s) from Ahsay Support.

www.ahsay.com AhsayCBS API Guide | 3 of 450

1.3 API ACCESS ACCOUNT TYPES
To allow a third-party program to utilize the API, it is suggested that you create a “System User”
which has permissions for API calls to your AhsayCBS.

For all APIs outlined in this guide with parameters, “SysUser” and “SysPwd”, they are the
username and password of any of the following types of “System User”:

Admin

API User

For some APIs, as listed in the following chapter in this guide, API with parameters
“SysUser” and “SysPwd,” are the username and password of the following type of
“System User”:

Read-Only API User

NOTE
Sub-Admin account types are not permitted to make any API request.

READ-ONLY API USER

AhsayCBS version 9 introduces the “Read-Only API User” account type. This allows your
application to access Read-Only data and not allow changes to be made if this account were to
be compromised.

VALID READ-ONLY API USER API METHODS

System API
API API Methods
System GetBuildingStatus GetReplicationStatus
GetDataMigrationProgress GetSystemStatus

System Config GetLicense (v1, v2) GetReplicationMode

GetSystemSetting (v1, v2) –
Backup Server
Group Policy ListPolicyGroups (v1, v2)
ListUserGroups

www.ahsay.com AhsayCBS API Guide | 4 of 450

 User API
API API Methods
User ListUsers (v1, v2) GetUser (v1, v2)
GetSingleUserRebuildStatus GetUserStatus
GetUserStorageStat GetServerRunJobStatus
Backup Set GetBackupJobProgress ListBackupJobStatus
GetBackupSet (v1, v2) ListBackupSets
ListBackupFiles ListRestoreJobs
ListBackupJobMode ListRestoreJobStatus
ListBackupJobs
Report GetBackupJobReport
GetBackupJobReportSummary
GetRestoreJobReport
RPS API
API API Methods
RPS Receiver ListReceiver

NOTE
For more information on each API and API Method, you may jump ahead to Chapters 2, 3, and 4
respectively.

www.ahsay.com AhsayCBS API Guide | 5 of 450

1.4 2FA ONE-TIME PASSCODE PARAMETER
Beginning with version 9.7, if a System User has Two-Factor Authentication enabled, or if
making use of an API that makes use of Immutable Destinations, a special Parameter will be
needed to authenticate each API call that a user makes.

Parameter Description
OnetimePasscode One-time passcode generated from an authenticator app. Required if 2FA is
enabled for SysUser or if destination to be added is immutable.

The one-time passcode to be used for the Parameter is the same passcode as shown on the
registered authenticator app. As these codes expire and change every few seconds, the code
input in the “OnetimePasscode” parameter also changes.

TO MAKE USE OF THIS SPECIAL PARAMETER, SEE API CALL SAMPLE BELOW :

INPUT for GetBuildingStatus.do?product=CBS

{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“OnetimePasscode”:”887707”
}
OUTPUT
{
“Status”:”OK”,
“lastUpdatedTime”:”2023-05-05 07:40:57”,
“message”:””,
“status”:”waiting”
}

www.ahsay.com AhsayCBS API Guide | 6 of 450

1.5 IP RESTRICTIONS

By default, AhsayCBS accepts and handles API requests from all IP addresses. To avoid being
exploited by hackers from an unauthorized network, you will need to setup IP filters.

SETUP IP FILTERS WITH THE FOLLOWING:

1. Stop the AhsayCBS service.

2. Open the web.xml file in the following paths:

%CBS_HOME%\webapps\cbs\WEB-INF\web.xml

%CBS_HOME%\webapps\rps\WEB-INF\web.xml

%CBS_HOME%\webapps\rdr\WEB-INF\web.xml

%CBS_HOME%\webapps\obs\WEB-INF\web.xml

NOTE
%CBS_HOME%\webapps\obs\WEB-INF\web.xml (“/obs/api/json/” API)
Cannot be fully restricted because it is used by the OBM and ACB Client agent
Can have restrictions if you include the range for all your user’s IP subnets

3. Locate the “ApiAccess” filter under the “filter” section.

4. Change the “Range2” (<param-name>Range2</param-name>) parameter value from

“0.0.0.-255.255.255.255” to another range of IP addresses from where APIs can be
invoked.

<filter>
<filter-name>ApiAccess</filter-name>
<filter-class>com.ahsay.obs.www.IPFilter</filter-class>
<init-param>
<param-name>Range1</param-name>
<param-value>localhost</param-value>
</init-param>
<init-param>
<param-name>Range2</param-name>
<param-value>0.0.0.0-255.255.255.255</param-value>
</init-param>
</filter>

www.ahsay.com AhsayCBS API Guide | 7 of 450

 For example, change the [Range2] value from “0.0.0.0-255.255.255.255” to
“192.168.1.1-192.168.1.255” to allow the 192.168.1.x network to invoke APIs.

<filter>
<filter-name>ApiAccess</filter-name>
<filter-class>com.ahsay.obs.www.IPFilter</filter-class>
<init-param>
<param-name>Range1</param-name>
<param-value>localhost</param-value>
</init-param>
<init-param>
<param-name>Range2</param-name>
<param-value>192.168.1.1-192.168.1.255</param-value>
</init-param>
</filter>

Please note that you can configure more than two IP ranges by adding additional init
parameters (i.e. “Range3”, “Range4”, and so on) to the filter XML tag. For example:

<filter>
<filter-name>ApiAccess</filter-name>
<filter-class>com.ahsay.obs.www.IPFilter</filter-class>
<init-param>
<param-name>Range1</param-name>
<param-value>localhost</param-value>
</init-param>
<init-param>
<param-name>Range2</param-name>
<param-value>192.168.1.1-192.168.1.255</param-value>
</init-param>
<init-param>
<param-name>Range3</param-name>
<param-value>192.168.2.1-192.168.2.255</param-value>
</init-param>
</filter>

5. Restart the AhsayCBS service.

www.ahsay.com AhsayCBS API Guide | 8 of 450

1.6 TROUBLESHOOTING
Here are some common mistakes when people write their own JSON scripts:

ERRONEOUS CHARACTERS (TRAILING SPACES)

Reason for the below error is the trailing space following “GetLicense.do “
“https://CBS.EXAMPLE.COM/obs/api/json/2/GetLicense.do ””
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY12456!@#$%”
}
Output
404 NOT FOUND

No body returned for response

SYNTAX ERRORS

SAMPLE 1

GetLicense.do API Input - Missing comma and/or double quote

{
“SysUser”:”api_user”,
“SysPwd”:qWeRtY12456!@#$%”
}
Output
{
“Status”:”Error”,
“Message”:”[Error] JSON Input Syntax is incorrect!”,
“ExptType”:”java.lang.Exception”
}

www.ahsay.com AhsayCBS API Guide | 9 of 450

Missing the above syntax would cause critical errors.
Correct input
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}
Output
{
“Status”:”OK”
}

SAMPLE 2

UpdateConfig.do API Input – Array missing square brackets “[ ]”

{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“SendBccReports”:true,
“AdminContacts”:{“Name”:”New1”,”Email”:[email protected]}
}
Output
{
“Status”:”Error”,
“Message”:”Invalid input type, JSONObject[\”AdminContacts\”] is not a
JSONArray (class org.json.JSONObject).”,
“ExptType”:”org.json.JSONException”
}

The input data type for AdminContacts is an array. Arrays must be set in square brackets “[ ]”.
Correct input
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“SendBccReports”:true,
“AdminContacts”:[{“Name”:”New1”,”Email”:[email protected]}]
}
Output
{
“Status:”OK”
}

www.ahsay.com AhsayCBS API Guide | 10 of 450

PARAMETER NAMES TYPO ERRORS

Getlicense.do API Input – Incorrect parameter name

{
“SySUser”:”api_user”,
“SySPwd”:”qWeRtY123456!@#$%”
}
Output
{
“Status”:”Error”,
“Message”:”[Error] Parameter SysUser is null!”
“ExptType”:”java.io.IOException”
}

Parameter names are case sensitive. Ensure that all parameter names are in the correct case, as
outlined in this document.
Correct input
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}
Output
{
“Status”:”OK”
}

EXTRA KEY INPUTS

UpdateUser.do API Input – Erroneous Key “foobar” is ignored

{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“LoginName”:”backup_user”,
“foobar”:”foobar_is_extra_and_irrelevant”
}
Output
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 11 of 450

Input of extra key(s) are ignored by AhsayCBS, is not validated, and will not display an error
code.

ESCAPE CHARACTER ERRORS

AddSelectSrc.do API Input – Character Backlash ( \ ) not escaped ( \\ )

{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“LoginName”:”opendirect”,
“BackupSetID”:”1497925931498”,
“NewSelectedSrc”:{“Src”:”C:\SelectSrcTestOBM”}
}

Output
{
“Status”:”Error”,
“Message”:”[Error] JSON Input Syntax is incorrect!”,
“ExptType”:”java.lang.Exception”
}

Make sure your values are specific for JAVA characters (e.g. “\\” for escape)
AddSelectSrc.do API Input – Character Backlash ( \ ) not escaped ( \\ )
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“LoginName”:”opendirect”,
“BackupSetID”:”1497925931498”,
“NewSelectedSrc”:{“Src”:”C:\\SelectSrcTestOBM”}
}
Output
{
“Status”:”OK”
}

INCORRECT API URL PATH

Incorrect https://CBS.EXAMPLE.COM/obs/api/json/UpdateConfig.do
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}

www.ahsay.com AhsayCBS API Guide | 12 of 450

 Output
No body returned for response

Make sure you point to the correct API URL path. For “UpdateConfig.do”, it is under /cbs/api.
Correct https://CBS.EXAMPLE.COM/cbs/api/json/UpdateConfig.do
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}
Output
{
“Status”:”OK”
}

ADDITIONAL INFORMATION
If the error message returned by the API call does not provide sufficient information, please login to the
AhsayCBS console for further details:
Dashboard > To Dos > API Errors

You can contact the Ahsay support team for further assistance.

www.ahsay.com AhsayCBS API Guide | 13 of 450

2 SYSTEM API
API’s that belong to this category deal with surface functions such as getting the status of basic
functions such as Builds and Migration; making changes to Servers, Licenses, and System
Settings; adding or removing System Users; and making changes to Policy and User Groups.

There are four subcategories under System API, with these being:
SUBCATEGORIES
SYSTEM
GetBuildingStatus GetDataMigrationProgress
GetReplicationStatus GetSystemStatus
SYSTEM CONFIG
UpdateServerConfig (V1), UpdateSystemSettings UpdateConfig (Backup Server)
(V2) (Backup Server)
GetSystemSettings (V1, V2) (Backup Server) UpdateReplicationConfig
UpdateLicense GetLicense (V1, V2)
GetReplicationMode AddPredefinedDestination
SYSTEM USER
AddSysUser UpdateSysUser
RemoveSysUser AuthSystemUser
ListSystemUsers
GROUP POLICY
AddUserGroup DeletePolicyGroup
DeletePolicyGroupFromUserGroup DeleteUserFromUserGroup
DeleteUserGroup ListPolicyGroups (V1, V2)
ListUserGroups ModifyUserGroup
UpdatePolicyGroup (V1, V2) AddPolicyGroup

www.ahsay.com AhsayCBS API Guide | 14 of 450

2.1 SYSTEM

This subcategory focuses on retrieving the base statuses and progress of AhsayCBS, featuring
four APIs that gives information to the user regarding AhsayCBS builds, progress on Data
Migration, status of any Replication and the overall system status of AhsayCBS.

GETBUILDINGSTATUS
This API can be used to get Build Installer status of either AhsayCBS build or Client’s build. The
related settings can be found on the AhsayCBS web console:

System Settings > Basic > Administrative Access > %system_user% > Rebrand Web
Console > Build Installers

System Settings > Basic > Administrative Access > %system_user% > Rebrand Clients >
Build Installers

URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetBuildingStatus.do?product=%product%
https://CBS.EXAMPLE.COM/cbs/api/json/GetBuildingStatus.do?product=%product%&mode=single
https://CBS.EXAMPLE.COM/cbs/api/json/GetBuildingStatus.do?product=%product%&mode=all
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API, or
Read-Only API role.
SysPwd String Password matching SysUser.
QUERY PARAMETERS
product String Either CBS or OBC
mode String (optional) all or single

www.ahsay.com AhsayCBS API Guide | 15 of 450

RETURN VALUES

WHEN MODE IS NOT SET TO “ALL”

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
lastUpdateTime String Last update time for the build process, in yyyy-MM-dd
hh:mm:ss.
message String Last updated message for the build process.
status String Build status: uploaded, waiting (idle), queued, building,
finished.
Message String Error message; it only appears if “status” displays “Error”.

WHEN MODE IS SET TO “ALL”

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
buildStatus Array of A list of build status for the System Users.
BuildStatus
Message String Error message; it only appears if “status” displays “Error”.

JSON OBJECTS

ARRAY:BUILDSTATUS

KEY TYPE DESCRIPTIONS

lastUpdatedTime String Last update time for the build process, in yyyy-MM-dd
hh:mm:ss.
message String Last updated message for the build process.
status String Build status: uploaded, waiting (idle), queued, building,
finished.
Id String System user ID (0=’system’ username).

www.ahsay.com AhsayCBS API Guide | 16 of 450

EXAMPLE INPUTS

EXAMPLE 1: PRODUCT IS CBS (INPUT = ?product=CBS)

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}
OUTPUT
{
“Status”:”OK”,
“lastUpdatedTime”:”2023-05-05 07:40:57”,
“message”:””,
“status”:”waiting”
}

EXAMPLE 2: MODE IS SET TO ALL (INPUT = ?product=OBC&mode=all)

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}
OUTPUT
{
“Status”:”OK”
“buildStatus”: [
{
“lastUpdatedTime”:”2021-06-03 12:20:10”,
“id”:”0”,
“message”:””,
“status”:”waiting”
}
]
}

www.ahsay.com AhsayCBS API Guide | 17 of 450

GETDATAMIGRATIONPROGRESS
This API can be used to get the v6 to AhsayCBS Blocks Backup Set Data Migration. The related
settings can be found on the AhsayCBS pre-v9 web console.

Backup/Restore > Basic > Backup Data Migration

URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetDataMigrationProgress.do
AVAILABLE SINCE VERSION:
7.7
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API, or
Read-Only API role.
SysPwd String Password matching SysUser.

www.ahsay.com AhsayCBS API Guide | 18 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message; it only appears if “status” displays “Error”.
MigratedFileCount Integer Number of file that has been migrated for the current backup
set.
MigratingFilePath String The file path that is under migration.

EXAMPLE

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}
OUTPUT
{
“Status”:”OK”,
“MigratingFilePath”:”C:\\ProgramFiles\AhsayCBS\users\user\files\
15544253452756\Current\0x14\0x45\0x12\0x00\5252334”,
“MigratedFileCount”: 15
}

www.ahsay.com AhsayCBS API Guide | 19 of 450

GETREPLICATIONSTATUS
This API can be used to get the Live Activities Replication Status of either the “Replication”
(Sender, AhsayCBS Backup Server) or “Receiver” (AhsayCBS Replication Server).

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

Monitoring > Live Activities > Replication

Monitoring > Live Activities > Receiver

URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetReplicationStatus.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API, or
Read-Only API role.
SysPwd String Password matching SysUser.
Type String Either: replicate or receive.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message; it only appears if “status” displays “Error”.
RepStatus Array of It exists only if Type is “replicate”.
RepStatus
RecStatus Array of It exists only if Type is “receive”.
RecStatus

www.ahsay.com AhsayCBS API Guide | 20 of 450

JSON OBJECTS

REPSTATUS “TYPE” IS “REPLICATE”

KEY TYPE DESCRIPTIONS

BackupSetName String Backup set name
LoginName String Backup username
Owner String Backup user owner
ClientType String OBM or ACB
isSysFiles Boolean True if replicate for user settings or system file, False if
replicate backup set data.
Mode String Mode: SLEEP, RESYNC, REPLAY, PENDING
Type String Backup set type
StartTime String Start time of the replication job
BackupSetID String Backup set ID
Alias String Alias of the job entry
ReplicatedFile String File being replicated
UserID String User ID
EstimatedTimeLeft String Estimated time left
ID String ID of this entry object
UserType String PAID or TRIAL
Progress Integer Percentage done of replication

RECSTATUS “TYPE” IS “RECEIVE”

KEY TYPE DESCRIPTIONS

ReplicatedFile String File last replicated
EstimatedTimeLeft String Estimated time left
Mode String Receiving mode
StartTime String Start time of the receiving job
Receiver String Receiver name
ID String ID of the receiver
inactive Boolean Inactive or not
Progress String Progress percentage

www.ahsay.com AhsayCBS API Guide | 21 of 450

EXAMPLES

EXAMPLE 1: TYPE IS “RECEIVE”

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“Type”:”receive”
}
OUTPUT
{
“Status”:”OK”,
“ReloadReceiveStatus”:”true”,
“RecStatus”:[
{
“ReplicatedFile”:””,
“Progress”:0,
“inactive”:true,
“EstimatedTimeLeft”:”—“,
“Mode”:”REPLAY”,
“StartTime”:”10:03:29”,
“Receiver”:”rcvr”,
“ID”:”3495085”
}
]
}

www.ahsay.com AhsayCBS API Guide | 22 of 450

EXAMPLE 2: TYPE IS “REPLICATE”

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“Type”:”replicate”
}
OUTPUT
{
“ReloadReplicateStatus”:”true”,
“Status”:”OK”,
“RepStatus”:[
{
“BackupSetName”:”v6 File Backup”,
“LoginName”:”obm”,
“Owner”:””,
“ClientType”:”OBM”,
“Progress”:100,
“Mode”:”SLEEP”,
“StartTime”:”10:05:15”,
“BackupSetID”:”1687750405259”,
“isSysFiles”:false,
“ReplicatedFile”:””,
“Type”:”FILE”,
“UserId”:”109818”,
“Alias”:”obm”,
“EstimatedTimeLeft”:”—“,
“ID”:”1687750405259”,
“UserType”:”PAID”
},
{
“BackupSetName”:”default-backup-set-name-1”,
“LoginName”:”obm”,
“Owner”:””,
“ClientType”:”OBM”,
“Progress”:100,
“Mode”:”SLEEP”,
“StartTime”:”06/29/2023 10:48:25”,
“BackupSetID”:”1687755057644”,
“isSysFiles”:false,
“ReplicatedFile”:””,
“Type”:”FILE”,
“UserId”:”109818”,

www.ahsay.com AhsayCBS API Guide | 23 of 450

 “Alias”:”obm”,
“EstimatedTimeLeft”:”—“,
“ID”:”1687755057644”,
“UserType”:”PAID”
},
{
“BackupSetName”:”Configuration and system files”,
“LoginName”:””,
“ClientType”:””,
“Progress”:0,
“Mode”:”SLEEP”,
“StartTime”:”—“,
“BackupSetID”:””,
“isSysFiles”:true,
“ReplicatedFile”:””,
“Type”:””,
“UserId”:”0”,
“Alias”:””,
“EstimatedTimeLeft”:”—“,
“ID”:””,
“UserType”:””
}
]
}

www.ahsay.com AhsayCBS API Guide | 24 of 450

GETSYSTEMSTATUS
This API can be used to get the Dashboard values of: CPU, Memory, and Live Threads.

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

Monitoring > Dashboard > CPU

Monitoring > Dashboard > Memory

Monitoring > Dashboard > Live Threads

URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetSystemStatus.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API, or
Read-Only API role.
SysPwd String Password matching SysUser.
Type String (optional) Values: memory, cpuUsage, or thread
When Type or StartDate is not input, overall result is
returned.
When Type and Startdate is input, history of the type is
returned.
StartDate String Date in yyyy-MM-dd format

www.ahsay.com AhsayCBS API Guide | 25 of 450

RETURN VALUES

“TYPE” OR “STARTDATE” IS NOT INPUT

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message; it only appears if “status” displays
“Error”.
nonHeapMemPoolList Array of Memory pool information for non heap.
MemPool
heapMemPoolList Array of Memory pool information for heap.
MemPool
garbageCollectorList Array of Garbage collection information
GarbageCollector
totalSwapSpace String Total swap space
heapUsed String Heap used
daemonThreads Integer Number of daemon threads
freeSwapSpace String Free swap space
peakThreads Integer Peak number of threads
nonHeapPercentage Integer Non heap size percentage
liveThreads Integer Number of live threads
committedVirtualMemory String Committed virtual memory
totalThreadsStarted Integer Total number of threads started
totalPhysicalMemory String Total physical memory
heapPercentage Integer Heap percentage
Timestamp Long Timestamp of the request
nonHeapUsed String Non heap size used
processCpuLoad Double Process CPU load
freePhysicalMemory String Free physical memory
systemCpuLoad Double System CPU load
maxNonHeap String Maximum non heap size
heapUsage Double Heap usage
maxHeap String Maximum heap size

www.ahsay.com AhsayCBS API Guide | 26 of 450

JSON OBJECTS

MEMPOOL

KEY TYPE DESCRIPTIONS

usedPercentage Integer Used percentage
Max Integer Maximum number of memory assigned
used Integer Memory used
formattedUsed String Formatted memory used
formattedMax String Formatted maximum number of memory
formattedPoolName String Formatted memory pool name
poolName String Memory pool name

GARBAGECOLLECTOR

KEY TYPE DESCRIPTIONS

time Integer Time
count Integer Count
formattedTime String Formatted time
Type String Type
formattedType String Formatted type

www.ahsay.com AhsayCBS API Guide | 27 of 450

EXAMPLES

EXAMPLE 1: NO TYPE / OVERALL RESULT

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}
OUTPUT
{
“Status”:”OK”
“totalswapSpace”:”9.25 G”,
“heapUsed”: “126.27 M”,
“daemonThreads”:41,
“freeSwapSpace”:”5.44 G”,
“peakThreads”:47,
“nonHeapMemPoolList”:[
{
“servletWrapper”:{},
“usedPercentage”:15,
“max”:251658240,
“formattedMax”:”240 M”,
“used”:39791424,
“formattedPoolName”:”CodeCache”,
“formattedUsed”:”37.95 M”,
“poolName”:”CodeCache”
}
{
“servletWrapper”:{},
“usedPercentage”:36,
“max”:268435456,
“formattedMax”:”256 M”,
“used”:98743520,
“formattedPoolName”:”Metaspace”,
“formattedUsed”:”94.17 M”,
“poolName”:”Metaspace”
}
{
“servletWrapper”:{},
“usedPercentage”:3,
“max”:260046848,
“formattedMax”:”248 M”,
“used”:9740424,

www.ahsay.com AhsayCBS API Guide | 28 of 450

 “formattedPoolName”:”CompressedClassSpace”,
“formattedUsed”:”9.29 M”,
“poolName”:”Compressed Class Space”
}
]
“nonHeapPercentage”:19,
“liveThreads”:43,
“committedVirtualMemory”:”793.76 M”,
“totalThreadsStarted”:158,
“totalPhysicalMemory”:”8 G”,
“garbageCollectorList”:[
{
“servletWrapper”:{},
“formattedType”:”ParNew”,
“count”:45,
“formattedTime”:”00:00:01.245”,
“time”:1245,
“type”:”ParNew”
}
{
“servletWrapper”:{},
“formattedType”:”ConcurrentMarkSweep”,
“count:”20,
“formattedTime”:”00:0:05.732”,
“time”:5732,
“type:”ConcurrentMarkSweep”,
{
]
“heapPercentage”:6,
“timestamp”:1683256740537,
“nonHeapUsed”:”141.4 M”,
“processCpuLoad”:0.18,
“freePhysicalMemory”:”4.29 G”,
“systemCpuLoad”:0.5,
“maxNonHeap”:”744 M”,
“heapUsage”:126.27443,
“maxHeap”:”1.99 G”,
“heapMemPoolList”:[
{
“servletWrapper”:{},
“usedPercentage”:5,
“max”:505413632,
“formattedMax”:”482 M”,
“used”:29969944,
“formattedPoolName”:”ParEdenSpace”,

www.ahsay.com AhsayCBS API Guide | 29 of 450

 “formattedUsed”:”28.58 M”,
“poolName”:”Par Eden Space”
}
{
“servletWrapper”:{},
“usedPercentage”:0,
“max”:15728640,
“formattedMax”:”15 M”,
“used”:0,
“formattedPoolName”:”ParSurvivorSpace”,
“formattedUsed”:”0”,
“poolName”:”Par Survivor Space”
{
}
“servletWrapper”:{},
“usedPercentage”:6,
“max”:1610612736,
“formattedMax”:”1.5 G”,
“used”:102438392,
“formattedPoolName”:”CMSOldGen”,
“formattedUsed”:”97.69 M”,
“poolName”:”CMS Old Gen”
}
]
}

EXAMPLE 2: TYPE = “MEMORY”

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“Type”:”memory”,
“StartDate”:”
}
OUTPUT
{
“Status”:”OK”,
“sysStatusList”:[
{
“timeStamp”:1683216012284,
“heapUsage”:144.28317”

www.ahsay.com AhsayCBS API Guide | 30 of 450

 },
{
“timeStamp”:1683216072391,
“heapUsage”:98.49154
}
]
}

EXAMPLE 3: TYPE= “THREAD”

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“Type”:”thread”
“SartDate”:”2023-05-05”
}
OUTPUT
{
“Status”:”OK”,
“sysStatusList”:[
{
“timeStamp”:1683216012284,
“liveThreads”:41
},
{
“timeStamp”:1683216072391,
“liveThreads”:41
}
]
}

www.ahsay.com AhsayCBS API Guide | 31 of 450

EXAMPLE 4: TYPE = “CPU”

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“Type”:”cpuUsage”,
“StartDate”:”2023-05-05”
}
OUTPUT
{
“Status”:”OK”,
“sysStatusList”:[
{
“timeStamp”:1683216012284,
“processCpuLoad”:0.01,
“systemCpuLoad”:1.25
},
{
“timeStamp”:1683216072391,
“processCpuLoad”:0.39,
“systemCpuLoad”:0.64
}
]
}

www.ahsay.com AhsayCBS API Guide | 32 of 450

2.2 SYSTEM CONFIG
This subcategory provides users with APIs that allows for the configuration of settings such as
servers and system settings, addition of predefined destinations, and updates to AhsayCBS
licenses among other functions.

UPDATESERVERCONFIG (V1), UPDATESYSTEMSETTINGS (V2) – BACKUP SERVER

This API can be used to update Backup Server related configuration such as the User Home and
Free Trial user registration settings only for the Admin, not SubAdmin.

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

Backup / Restore > Basic > User Home or Free Trial Options

V1 UPDATESERVERCONFIG.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateServerConfig.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 UPDATESYSTEMSETTING.DO

UpdateSystemSetting.do was introduced for handling of features related to Quota

Management.

A TrialQuotaList JSON Object (list of quota for multiple backup destinations for free trial users)
was introduced to replace the single BackupQuotaSize parameter (v1 API).

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/UpdateSystemSetting.do
AVAILABLE SINCE VERSION:
9.5
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API,
or Read-Only API role.
SysPwd String Password matching SysUser.

www.ahsay.com AhsayCBS API Guide | 33 of 450

UserHomes Array When new user home is added, you need to include
your existing user home in the array.
EnableFreeTrial Boolean Enable / Disable the Free Trial Registration option.
TrialQuotaList Array List of quota of backup destination for trial user, unit in
byte.
ExpTrialStatus String “reset” or “suspend”
ExpTrialQuota String The quota of expired trial users, in number of bytes.
SuspendUserDays Integer The number of days when a user will be suspended.
The value can be any one of the following:
7, 8,…, 29, 30, 45, 60, 75, 90
TrialMsExchange Boolean Enable / Disable the trial of Microsoft Exchange Server
add-on module.
TrialMsSql Boolean Enable / Disable the trial of Microsoft SQL Server add-on
module.
TrialMySql Boolean Enable / Disable the trial of MySQL Database Server add-
on module.
TrialMariaDB Boolean Enable / Disable the trial of MariaDB add-on module.
TrialOracle Boolean Enable / Disable the trial of Oracle Database Server add-
on module.
TrialDomino Boolean Enable / Disable the trial of Lotus Domino add-on
module.
TrialNotes Boolean Enable / Disable the trial of Lotus Notes add-on module.
TrialWinServer2008BareMetal Boolean Enable / Disable the trial of Windows System Backup
add-on module.
TrialMsWinSysState Boolean Enable / Disable the trial of Windows System State
Backup add-on module.
TrialVMware Boolean Enable / Disable the trial of VMware add-on module.
TrialVMwareQuota String VMware VM module quota. Enter integer value in string
format.
TrialVmwareQuotaType String Default value is GUESTVM if not provided.
The value can be any one of the following:
GUESTVM
SOCKET
TrialMsVm Boolean Enable / Disable the trial of Hyper-V add-on module.
TrialMsVmQuota String Hyper-V module quota. Enter integer value in string
format.
TrialMsVmQuotaType String Default is GUESTVM if not provided.
The value can be any one of the following:
GUESTVM
SOCKET

www.ahsay.com AhsayCBS API Guide | 34 of 450

TrialMsExchangeMailbox Boolean Enable / Disable the trial of Microsoft Exchange Mailbox
add-on module.
TrialEMBQuota String Microsoft Exchange mailbox module quota. Enter
integer value in string format.
TrialNasClient Boolean Enable / Disable the trial of NAS add-on module
TrialQnap Boolean Enable / Disable the trial of Qnap NAS add-on module.
TrialShadowProtectBareMetal Boolean Enable / Disable the trial of Shadow Protect System
Backup add-on module.
TrialShadowCopy Boolean Enable / Disable the trial of Volume Shadow Copy add-
on module.
TrialCdp Boolean Enable / Disable the trial of Continuous Data Protection
add-on module.
TrialDeltaBlock Boolean Enable / Disable the trial of In-File Delta add-on module.
TrialMobile Boolean Enable / Disable the trial of Mobile add-on module.
TrialMobileQuota String Mobile add-on module quota. Enter integer value in
string format.
TrialOffice365Mail Boolean Enable / Disable the trial of Microsoft 365 online backup
add-on module.
TrialOpenDirect Boolean Enable / Disable the trial of Open Direct / Granular
Restore add-on module.
TrialOpenDirectQuota String Open Direct / Granular Restore quota. Enter integer
value in string format.
EnableRemoveUser Boolean Enable / Disable the remove trial user.
RemoveUserDays String Enter integer value in string format.
SinceInactive Boolean Time period in which user has been inactive.
TrialQuotaType String Quota Type, either TOTAL_QUOTA or
PER_DESTINATION_QUOTA.
TrialStorageQuota Long Total Quota in GB.
Value validity examined when used by TOTAL_QUOTA.
TrialDeduplication Boolean Enable / Disable the trial of Deduplication add-on
module.
TrialTibero Boolean Enable / Disable the trial of TIbero Database Server add-
on module.
TrialLinuxBareMetal Boolean Enable / Disable the trial of Linux Bare Metal add-on
module.

www.ahsay.com AhsayCBS API Guide | 35 of 450

JSON OBJECTS

USERHOME

KEY TYPE DESCRIPTIONS

Path String Path of user home, e.g. “F:\\new_home”.
Quota String Maximum QPS ratio of the user home.
The value can be any one of the following:
Unlimited
300
250
200
150
100
90
80
70
60
50
40
30
20
10
0
“0” refers to “Not Used”
status String Build status: uploaded, waiting (idle), queued, building,
finished.
Id String System user ID (0=’system’ username)

TRIALQUOTALIST

KEY TYPE DESCRIPTIONS

Enabled Boolean Enables or Disables “Destinations” added/listed when “Per
Destination Quota” is enabled.
Quota Long Quota of the backup destination, unit in byte.
Value validity examined when used by
PER_DESTINATION_QUOTA.
DestinationKey String ID of the backup destination, or “OBS” for AhsayCBS
DestinationName String Example “AhsayCBS”

www.ahsay.com AhsayCBS API Guide | 36 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
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”.

EXAMPLES

EXAMPLE 1: INPUT = UpdateUserHomes

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“TrialQuotaList”:[
{
“Enable”:true
“Quota”:549750000
“DestinationKey”:”OBS”
},
{
“Enable”:true
“Quota”:549750000
“DestinationKey”:”-1585973679332”
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 37 of 450

EXAMPLE 2: INPUT = DisableTrialMariaDB

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
“TrialMariaDB”:false
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 38 of 450

UPDATECONFIG – BACKUP SERVER
The UpdateConfig.do API can be used to update the following settings of AhsayCBS:

Proxy server

Admin contacts

System Homes

SNMP settings

Windows Event Logs

Connectors

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

System Settings > Basic > General or Email

System Settings > Advanced > Proxy or Logging

URL
https://CBS.EXAMPLE.COM/cbs/api/json/UpdateConfig.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with
Admin, API, or Read-Only API role.
SysPwd String Password matching SysUser.
UseEventLog Boolean Whether event log is enabled.
EventLogName String Name of event log.
Hostname String Hostname of the AhsayCBS server.
SystemHome String The directory containing all system files.
WebServers Array of Connectors
WebServer
SmtpServers Array of Smtp Servers settings
Smtpserver
AdminContacts Array of Contact Admin contacts in array
UseProxy Boolean Enable proxy server
ProxyUsername String User name of proxy server.

www.ahsay.com AhsayCBS API Guide | 39 of 450

ProxyPassword String Password of the user of the proxy server.
ProxyType String The value can be any one of the following:
HTTP
SOCK
ProxyHost String Hostname of the proxy server.
ProxyPort String Port used by the proxy server.
ProxyExcludeHosts Array of If you need to exclude some hostnames and IP
ProxyExcludeHost addresses for proxy connection, you can add
those excluded hostnames and IP addresses.
EnableSnmp Boolean “true” or “false” to Enable / Disable SNMP
SnmpStartIP String Starting IP for SNMP
SnmpEndIP String Ending IP for SNMP
SnmpTrapInfo Boolean SNMP Trap level information
SnmpTrapWarn Boolean SNMP Trap Level Warning
SnmpTrapErr Boolean SNMP Trap Level Error
SnmpPort Integer SNMP Trap port numbers
SnmpTrapRecv1 SnmpTrapRecv Receiver 1
SnmpTrapRecv2 SnmpTrapRecv Receiver 2
SnmpTrapRecv3 SnmpTrapRecv Receiver 3
PreventSessionHijackingEnabled Boolean “true” or “false” to Enable / Disable prevent
session hijacking
QUERY PARAMETERS
Product String Either “CBS” or “OBC”
Mode String (optional) “all” or “single”

www.ahsay.com AhsayCBS API Guide | 40 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
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

WEBSERVER

KEY TYPE DESCRIPTIONS

Id Integer Usually start from 0, ascending order.
Ip String This is designed for servers with multiple IP addresses. This
attribute specifies which IP address will be used for listening
on the specified port. If only one (1) IP address is used on
your system, the default value 0.0.0.0 can be used.
Port String The TCP port number on which this connector will create a
server socket and await incoming connections. Please make
sure this port is not occupied by other applications in your
system.
Protocol String The value can be any one of the following:
http
https
MaxConn String Maximum number of connections allowed to server.
MaxKeepAliveReq String Maximum number of requests to serve on a TCP connection.
ConnTimeout String Connection timeout (milliseconds)
SslCertificateId String Name of an existing SSL Cert present in AhsayCBS. Empty
string if not applicable.
RxBufSize String Size in bytes of the receive buffer socket. Default = 25188
TxBufSize String Size in bytes of the send buffer socket. Default = 43800

www.ahsay.com AhsayCBS API Guide | 41 of 450

SMTPSERVER

KEY TYPE DESCRIPTIONS

HostName String Host Name of the SMTP server.
Port Integer Connection port of the SMTP server.
SecureProtocol Boolean If set to true, it will require a secure protocol for login.
Auth Boolean set value = False, if SMTP server does not require login
credentials.
AuthUser String User name used to login.
AuthPwd String User Password
ReportSender Contact Contact that sends Reports.
Owner String Name of owner, empty if owner is Admin.

CONTACT

KEY TYPE DESCRIPTIONS

Name String Primary name of Contact.
Owner String Name of owner, empty if owner is Admin.
Email String Example: [email protected]
Address String Address detail of contact.
ReceiveBccEmail Boolean True / False: allows BCC of outgoing emails

PROXYEXCLUDEHOST

KEY TYPE DESCRIPTIONS

Host String Hostname or IP Address of the proxy server.

SNMPTRAPRECV

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
Host String Hostname of SNMP.
TrapPort String Port to be used for trap.

www.ahsay.com AhsayCBS API Guide | 42 of 450

REPORTSETTINGSBEAN

KEY TYPE DESCRIPTIONS

SendLowDiskSpaceReminderAlert Boolean Whether Low Disk Space Reminder/Alert
report will be sent to admin/subadmin.
LowDiskSpaceReminderThreshold Integer Threshold value for sending reminder
when disk space is low.

Value can be one of the following: 60,

65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95,
96, 97, 98, 99
LowDiskSpaceAlertThreshold Integer Threshold value for sending alert when
disk space is low.

Value can be one of the following: 60,

65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95,
96, 97, 98, 99
SendLowDestinationSpaceReminderAlertReport Boolean Whether Low Destination Space
Reminder / Alert report will be sent to
admin/subadmin.
LowDestinationSpaceReminderThreshold Integer Threshold value for sending reminder
when destination space is low.

Value can be one of the following: 60,

65, 70, 80, 85, 90, 91, 92, 93, 94, 95, 96,
97, 98, 99
LowDestinationSpaceAlertThreshold Integer Threshold value for sending alert when
destination space is low.

Value can be one of the following: 60,

65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95,
96, 97, 98, 99
SendAdministratorConsolidatedReport Boolean Whether Consolidated Admin report will
be sent to admin/subadmin.
ConsolidatedReportSendHour Integer Hour when consolidated report is sent.
“0”, “1”…”23” can be set.
ConsolidatedReportSendMin Integer Minute when consolidated report is sent.
“0”, “15”, “30”, “45” can be set.

www.ahsay.com AhsayCBS API Guide | 43 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“SendBccReports”:true,
“AdminContacts”:[{“Name”:”New1”,”Email”:”[email protected]”}]
}
OUTPUT
{
“Status”:”OK”
}

REPORTSETTINGSBEAN

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“ReportSettingsBean”:{
“SendLowDiskSpaceReminderAlertReport”:true,
“SendLowDestinationSpaceReminderAlertReport”:true,
“LowDestinationSpaceAlertThreshold”:90,
“LowDestinationSpaceReminderThreshold”:65,
“LowDiskSpaceAlertThreshold”:85,
“LowDiskSpaceReminderThreshold”:70,
“SendAdministratorConsolidatedReport”:true,
“ConsolidatedReportSendHour”:13,
“ConsolidatedReportSendMind”:45
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 44 of 450

GETSYSTEMSETTING (V1, V2) – BACKUP SERVER
This API can be used to retrieve backup server related configuration such as the User Home and
Free Trial Options only for the Admin, not SubAdmin.

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

Backup/Restore > Basic > User Home or Free Trial Options

V1 GETSYSTEMSETTING.DO

URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetSystemSetting.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 GETSYSTEMSETTING.DO

GetSystemSetting.do was introduced for handling of features related to Quota Management.

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/GetSystemSetting.do
AVAILABLE SINCE VERSION:
9.5
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API,
or Read-Only API role.
SysPwd String Password matching SysUser.

www.ahsay.com AhsayCBS API Guide | 45 of 450

RETURN VALUES

RETURN VALUES
KEY TYPE DESCRIPTIONS
Status String “OK” or “Error”
Data ConfigData Particulars of a user’s configuration data.
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

USERHOMES

KEY TYPE DESCRIPTIONS

QuotaSum Long Consiladated total of a user’s Quota in UserHomes.
Quota String Maximum quota of a user.
PasswordProtected Boolean Whether it is located at password protected network drive.
Password String Password used to login to user account.
Username String Login of a user account.
CurrentRatio Long Current QPS Ratio.
Path String Path to the user home.
Size Long Size of the user home.

CONFIGDATA

KEY TYPE DESCRIPTIONS

EnableFreeTrial Boolean Enable / Disable the Free Trial Registration option.
ExpTrialStatus String “reset” or “suspend”
SuspendUserDays Integer The number of days that a user will be suspended.
The value can be any one of the following:
“7”, “8”,…, “29”, “30”, “45”, “60”, “75”, “90”
SinceInactive Boolean Time period in which user has been inactive.
TrialMsExchange Boolean The trial option of Microsoft Exchange Server add-on
module.
TrialMsSql Boolean The trial option of Microsoft SQL Server add-on module.
TrialMySql Boolean The trial option of MySQL Database Server add-on
module.

www.ahsay.com AhsayCBS API Guide | 46 of 450

TrialOracle Boolean The trial option of Oracle Database Server add-on
module.
TrialDomino Boolean The trial option of Lotus Domino add-on module.
TrialNotes Boolean The trial option of Lotus Notes add-on module.
TrialWinServer2008BareMetal Boolean The trial option of Windows System Backup add-on
module.
TrialMsWinSysState Boolean The trial option of Windows System State Backup add-
on module.
TrialVMware Boolean The trial option of VMware add-on module.
TrialVMwareQuotaType Array Default value is GUESTVM if not provided.
The value can be any one of the following:
GUESTVM
SOCKET
TrialMsVm Boolean The trial option of Hyper-V add-on module.
TrialMsVmQuota String Hyper-V module quota.
TrialMsVmQuotaType Array Default value is GUESTVM if not provided
The value can be any one of the following:
GUESTVM
SOCKET
TrialMsExchangeMailbox Boolean The trial option of Microsoft Exchange Mailbox add-on
module.
TrialEMBQuota String Microsoft Exchange Mailbox module quota.
TrialNasClient Boolean The trial option of NAS add-on module.
TrialQnap Boolean The trial option of Qnap NAS add-on module.
TrialShadowProtectBareMetal Boolean The trial option of Shadow Protect System Backup add-
on module.
TrialShadowCopy Boolean The trial option of Volume Shadow Copy add-on
module.
TrialCdp Boolean The trial option of Continuous Data Protection add-on
module.
TrialDeltaBlock Boolean The trial option of In-File Delta add-on module.
TrialMariaDB Boolean The trial option of Mobile add-on module.
TrialMobile Boolean The trial option of Mobile add-on module.
TrialMobileQuota String The Quota of mobile add-on module.
TrialOpenDirect Boolean The trial option of Open direct/Granular restore add-on
module.
TrialOpenDirectQuota String The Quota of Open direct/Granular restore add-on
module.
EnableRemoveUser Boolean The option of trial user removal.

www.ahsay.com AhsayCBS API Guide | 47 of 450

RemoveUserDays String The number of days to remove user after registration.
The value can be any one of the following:
30
60
90
120
150
180
UserHomes Array Local path Users use as User Home destination.
TrialQuotaType String Quota Type, either TOTAL_QUOTA or
PER_DESTINATION_QUOTA.
TrialStorageQuota Long Total Quota in GB. Value validity examined when used
by TOTAL_QUOTA.
TrialDeduplication Boolean Enable / Disable the trial of Deduplication add-on
module.
TrialTibero Boolean The trial option of Tibero Database Server add-on
module.
TrialLinuxBareMetal Boolean The trial option of Linux Bare Metal add-on module.

REPORTSETTINGSBEAN

KEY TYPE DESCRIPTIONS

SendLowDiskSpaceReminderAlertReport Boolean Whether Low Disk Space Reminder /
Alert report will be sent to
admin/subadmin.
LowDiskSpaceReminderThrehshold Integer Threshold value for sending reminder
when disk space is low.

Value can be one of the following: 60,

65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95,
96, 97, 98, 99
LowDiskSpaceAlertThreshold Integer Threshold value for sending alert when
disk space is low. Value can be one of the
following: 60, 65, 70, 75, 80, 85, 90, 91,
92, 93, 94, 95, 96, 97, 98, 99
SendLowDestinationSpaceReminderAlertReport Boolean Whether Low Destination Space
Reminder / Alert report will be sent to
admin/subadmin.
LowDestinationSpaceReminderThreshold Integer Threshold value for sending reminder
when destination space is low.

www.ahsay.com AhsayCBS API Guide | 48 of 450

 Value can be one of the following: 60,
65, 70, 75, 80, 85, 90, 91, 92, 93, 94, 95,
96, 97,98, 99
LowDestinationSpaceAlertThreshold Integer Threshold value for sending alert when
destination space is low. Value can be
one of the following: 60, 65, 70, 75, 80,
85, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
SendAdministratorConsolidatedReport Boolean Whether Consolidated Admin report will
be sent to admin/subadmin.
ConsolidatedReportSendHour Integer Hour when consolidated report is sent.
“0”, “1”…”23” can be set
ConsolidatedReportSendMin Integer Minute when consolidated report is sent.
“0”, “15”, “30”, “45” can be set.

TRIALQUOTALIST

KEY TYPE DESCRIPTIONS

Name Boolean Name of the backup destination.
Quota String Unit in bytes.
Value validity examined when used by
PER_DESTINATION_QUOTA.
DestinationKey String ID of the predefined destination, or OBS for quota on
AhsayCBS.
Quota Integer Unit in bytes.

www.ahsay.com AhsayCBS API Guide | 49 of 450

EXAMPLE

EXAMPLE 1

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
}
Output
{
“Status”:”OK”
“Data”:{
“TrialMsVmQuotaTypes”:[],
“TrialMsVmQuota”:”5”,
“TrialDeduplication”:false,
“TrialCdp”:false,
“TrialMySql”:false,
“TrialQuotaType”:”TOTAL_QUOTA”,
“TrialMobileV2”:false,
“ExpTrialStatus”:”suspend”,
“TrialShadowCopy”:true,
“TrialMobile”:false,
“TrialShadowProtectBareMetal”:false,
“TrialWinServer2008BareMetal”:false,
“TrialMsVmQuotaType”:”GUESTVM”,
“TrialQuotaList”:[
{
“DestinationKey”:”OBS”,
“Quota”:52428800,
“Enabled”:true,
“Name”:”AhsayCBS”
}
]
“TrialMobileQuotaV2”:”0”,
“TrialVMware”:false,
“TrialOracle”:false,
“TrialVMwareQuotaTypes”:[],
“RemoveUserDays”:”90”,
“ReportSettingsBean”:{
“SendLowDiskSpaceReminderAlertReport”:true,
“SendLowDestinationSpaceReminderAlertReport”:true,
“ConsolidatedReportSendHour”:13,
“LowDestinationSpaceAlertThreshold”:90,
“LowDestinationSpaceReminderThreshold”:65,
“LowDiskSpaceAlertThreshold”:80,
“LowDiskSpaceReminderThreshold”:70,

www.ahsay.com AhsayCBS API Guide | 50 of 450

 “SendAdministratorConsolidatedReport”:true,
“ConsolidatedRepotSendMin”:45
},
“TrialStorageQuota”:85,
“TrialOffice365Mail”:false,
“TrialMsVm”:false,
“TrialMobileQuota”:”0”,
“TrialVMwareQuota”:”15”,
“TrialOpenDirect”:false,
“TrialNasClient”:false,
“TrialMsSql”:false,
“TrialNotes”:false,
“TrialOpenDirectQuota”:”10”,
“UserHomes”:[
{
“Path”:”C:\\Users\\username\\Documents”,
“QuotaSum”:53896806400,
“Quota”:”Unlimited”,
“Username”:””,
“Size”:959637876736,
“CurrentRatio”:5.6163692,
“PasswordProtected”:false,
“Password”:””
},
{
“Path”:”C:\\Users\\username\\Desktop”,
“QuotaSum”:104857600,
“Quota”:”Unlimited”,
“Username”:””,
“Size”:959637876736,
“CurrentRatio”:0.010926789,
“PasswordProtected”:false,
“Password”:”y8.BxMA=”
}
],
“TrialEMBQuota”:”20”,
“TrialDomino”:false,
“TrialQnap”:false,
“TrialMsExchangeMailbox”:false,
“EnableFreeTrial”:true,
“TrialMsExchange”:false,
“TrialOffice365MailQuota”:”10”,
“EnableRemoveUser”:true,
“TrialDeltaBlock”:false,
“SinceInactive”:false,
“SuspendUserDays”:25,
“TrialMariaDB”:true,
“TrialLinuxBareMetal”:false,

www.ahsay.com AhsayCBS API Guide | 51 of 450

 “TrialVMwareQuotaType”:”GUESTVM”,
“TrialMsWinSysState”:false
}
}

www.ahsay.com AhsayCBS API Guide | 52 of 450

UPDATEREPLICATIONCONFIG
This API can be used to update the following replication settings:
Replication destination
Replication Proxy server
Replication traffic limit
Replication backup set

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

Replication > Sending Data > Replication
URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateReplicationConfig.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API,
or Read-Only API role.
SysPwd String Password matching SysUser.
EnableReplication Boolean Enable / Disable the option to replicate back up data to
predefined cloud storage.
RepDestId String Destination ID of the replication destination.
ReplicationUseProxy Boolean Enable / Disable the use of proxy option in replication
profile.
ReplicationUseTrafficLimit Boolean Enable / Disable the use of replication traffic limit.
TrafficLimits Array of Configure the traffic limit settings to control traffic at a
TrafficLimit specific time.
ReplicateIndividualBSet Boolean Enable / Disable the option to replicate individual
backup set.
ReplicateNewPaidBSet Boolean Enable / Disable the option to replicate new backup sets
of paid users.
ReplicateNewTrialBSet Boolean Enable / Disable the option to replicate new backup sets
of trial users.
RepBSet Array of List of individual backup sets marked for individual
RepBset replication.

NOTE
For Parameter “RepBSet”, the array must relist to contain all backup sets for replication.

www.ahsay.com AhsayCBS API Guide | 53 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
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

TRAFFICLIMIT

KEY TYPE DESCRIPTIONS

StartDayOfWeek Integer The start day of traffic limit. “1” stands for Sunday, “2” stands
for “Monday”, and so on.
StartHour Integer The start hour of traffic limit. “0”, “1”…”23” can be set.
StartMin Integer The start minute of traffic limit. “0”, “1”…”59” can be set.
EndDayOfWeek Integer The end day of traffic limit. “1” stands for Sunday, “2” stands
for “Monday” and so on.
EndHour Integer The end hour of traffic limit “0”, “1”…”23” can be set.
EndMin Integer The end minute of traffic limit. “0”, “1”…”59” can be set.
MaxTransferPerSec String Maximum number of Kbytes transferred per second.

REPBSET

KEY TYPE DESCRIPTIONS

Value String The username and backup set ID of the replicated backup
set, joined with “++” as separator. For example,
UserABC++123456789

NOTE
For Key “Value”, API will update the whole list, so any existing backup sets in the list will be removed if your
“RepBSet” array does not include them.

www.ahsay.com AhsayCBS API Guide | 54 of 450

EXAMPLES

EXAMPLE 1: TRAFFIC LIMIT

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“EnableReplication”:true,
“ReplicationUseTrafficLimit”:true,
“TrafficLimits”:[
{
“StartDayOfWeek”:”4”,
“StartHour”:”3”,
“StartMin”:”30”,
“EndDayOfWeek”:”5”,
“EndHour”:”4”,
“EndMind”:”30”,
“MaxTransferPerSec”:”300”,
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 55 of 450

EXAMPLE 2: CREATE OR UPDATE REPBSET LIST (NOT NECESSARY TO INCLUDE SUBADMIN#)

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“EnableReplication”:true,
“ReplicateIndividualBset”:true,
“RepBSet”:[
{“Value”:”user12345++1578027193000”},
{“Value”:”user67890++1578059639000”},
]
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 3: ENABLE REPLICATION NEW TRIAL BACKUPSETS

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“EnableReplication”:true,
“ReplicateNewTrialBSet”:true
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 56 of 450

UPDATELICENSE

This API can be used to update the license name and license key on the AhsayCBS server (for
backup server).

This setting can be found on the AhsayCBS web console at:

System Settings > License > Backup

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateLicense.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API,
or Read-Only API role.
SysPwd String Password matching SysUser.
Licensee String Licensee name
Key String Product Key
UseProxy Boolean Enable / Disable the use of proxy defined in the
AhsayCBS to connect the internet.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is “Error”.
ExptType String The type of exception, will only be displayed if the status is
“Error”.

www.ahsay.com AhsayCBS API Guide | 57 of 450

EXAMPLES

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“Licensee”:”ABC_Backup”,
“Key”:”XyZ98-AbcDE-fGhU-98bcd-YZ”
}
OUTPUT 1 – WHEN LICENSE STATUS IS NORMAL
{
“Status”:”OK”,
“Key”:”XyZ98-AbcDE-fGhIJ-98bcd-YZ”,
“Deactivated”:false,
“Licensee”:”ABC_Backup”
}
OUTPUT 2 – USER ACTION REQUIRED (e.g. CLICK THE UPDATE BUTTON ON THE WEB CONSOLE)
{
“Status”:”OK”,“Key”:”XyZ98-AbcDE-fGhIJ-98bcd-
YZ”,“Deactivated”:false,”Info”:
“Internal Error 1012. Please press the [Update] button in license page
to correct this problem.
If the problem persists, please contact our technical support team to
resolve this problem”, “Licensee”:
“ABC_Backup”
}
OUTPUT 3 – WHEN INCORRECT LICENSE KEY WAS PROVIDED
{
“Status”:”Error”,
”Message”:”License key incorrect. Please try again.”
}
OUTPUT 4 – WHEN AHSAYCBS SERVICE WAS STOPPED
{
“Status”:”OK”,”Key”:”XyZ98-AbcDE-fGhIJ-98bcd-
YZ”,”Deactivated”:false,”Info”:”[OEM-License.checkLicTime] License expired
on 1970-01-01. Backup server is stopped”,”Licensee”:”ABC_Backup”
}

www.ahsay.com AhsayCBS API Guide | 58 of 450

GETLICENSE (V1, V2)

This API can be used to collect the license and usage information of your AhsayCBS server.

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

System Settings > License > Backup

V1 GETLICENSE.DO

URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetLicense.do
AVAILABLE SINCE VERSION:
8.3

V2 GETLICENSE.DO

Since AhsayCBS version 8.3, the following add-on modules are combined into one add-on
module, to make these modules that were previously separated, interchangeable:
Hyper-V and VMware (Per Guest VM)
Hyper-V and VMware (Per Socket)
NAS – Synology and NAS – QNAP
AhsayOBM and AhsayACB Microsoft 365

www.ahsay.com AhsayCBS API Guide | 59 of 450

To facilitate such changes, a new version of the GetLicense.do API (v2 GetLicense.do) was
introduced with the following parameters:

KEY TYPE DESCRIPTIONS

VMQuota String Hyper-V or VMware Guest VM Quota
UsedVMQuota String Used Hyper-V or VMware Guest VM Quota
RemainVMQuota String Available Hyper-V or VMware Guest VM Quota
HypervisorSocketQuota String Hyper-V or VMware Socket Quota
UsedHypervisorSocketQuota String Used Hyper-V or VMware Socket Quota
RemainHypervisorSocketQuota String Available Hyper-V or VMware Socket Quota
NasQuota String Synology or QNAP NAS client quota
UsedNasQuota String Used Synology or QNAP NAS client quota
Office365Quota String AhsayOBM or AhsayACB Microsoft 365 Quota
UsedOffice365Quota String Used AhsayOBM or AhsayACB Microsoft 365 Quota
RemainOffice365Quota String Available AhsayOBM or AhsayACB Microsoft365 Quota

For Ahsay CBS pre-8.3, you should use the v1 API instead. For all other new versions, use the v2
API to get accurate licensing details.

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/GetLicense.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API,
or Read-Only API role.
SysPwd String Password matching SysUser.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data ConfigData Contains the particulars of a user’s License.
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”.

www.ahsay.com AhsayCBS API Guide | 60 of 450

JSON OBJECTS

LICENSING DATA

KEY TYPE DESCRIPTIONS

Key String Product Key.
Licensee String Licensee name.
ProductName String Name of the product, e.g. “Offsite Backup Software,
OEM Edition”.
Version String Version of the AhsayCBS.
UseProxy Boolean Enable / Disable the use of proxy defined in the
AhsayCBS to connect to the internet.
LicTypeName String Name of license type.
MaxObmUsers String Maximum number of OBM user CALs.
UsedObmQuota String Used OBM user CALs.
RemainObmQuota String Remaining OBM user CALs.
ExpiryDate String Expiry date of the license key.
SupExpDate String Expiry date of the software support.
MaxQuota String Maximum backup quota of a user.
Ip String The IP address of the AhsayCBS registered.
Port String The connection port of the AhsayCBS registered.
Mac String The MAC address of the network card that the
AhsayCBS registered.
MaxUsers String Maximum number of users allowed.
AcbClientEnabled Boolean Enable / Disable the use of the ACB client module.
DagUseObm String Used OBM CALs due to DAG usage.
AcbUseObm String Used OBM CALs due to no ACB CALs.
EnableReplication Boolean Enable / Disable the use of the replication module.
EnableMSExchangeMailbox Boolean Enable / Disable the use of the Exchange Mailbox
module.
ExchangeMailboxQuota String Exchange Mailbox quota.
UsedExchangeMailboxQuota String Used Exchange Mailbox quota.
RemainExchangeMailboxQuota String Remaining Exchange Mailbox quota.
VMQuota String Hyper-V / VMware (Per Guest VM) quota.
UsedVMQuota String Used Hyper-V / VMware (Per Guest VM) quota.
RemainVMQuota String Remaining Hyper-V / VMware (Per Guest VM) quota.
HypervisorSocketQuota String Hyper-V / VMware (Per Socket) quota.
UsedHypervisorSocketQuota String Used Hyper-V / VMware (Per Socket) quota.

www.ahsay.com AhsayCBS API Guide | 61 of 450

RemainHypervisorSocketQuota String Remaining Hyper-V / VMware (Per Socket) quota.
EnableMobile Boolean Enable / Disable the use of AhsayMOB.
MobileQuota String AhsayMOB quota.
UsedMobileQuota String Used AhsayMOB quota.
RemainMobileQuota String Remaining AhsayMOB quota.
Office365Quota String AhsayACB / AhsayOBM Microsoft 365 mail quota.
UsedOffice365Quota String Used AhsayACB / AhsayOBM Microsoft 365 mail
quota.
RemainOffice365Quota String Remaining AhsayACB / AhsayOBM Microsoft 365
mail quota.
OpenDirectQuota String Granular restore / open direct quota.
UsedOpenDirectQuota String Used Granular restore / open direct quota.
RemainOpenDirectQuota String Remaining Granular restore quota.
NasQuota String Synology / QNAP – NAS client quota.
UsedNasQuota String Used Synology / QNAP – NAS client quota.
RemainNasQuota String Remaining Synology / QNAP – NAS client quota.
Deactivated Boolean Disabled / Enabled license key.
EnableNasServer Boolean Enable / Disable the NAS server module.
EnableUbs Boolean Enable / Disable the AhsayUBS module.
EnableHa Boolean Enable / Disable the HA module.
MobileQuotaV2 String Ahsay Mobile Backup quota.
UsedMobileV2Quota String Used Ahsay Mobile Backup quota.
RemainMobileV2Quota String Remaining Ahsay Mobile Backup quota.

EXAMPLE

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”
}

OUTPUT
{
“Status”:”OK”,
“Data”:{
“MobileQuota”:”2000”,
“HypervisorSocketQuota”:”4000”,

www.ahsay.com AhsayCBS API Guide | 62 of 450

 “ExpiryDate”:”12/31/2023”,
“RemainMobileV2Quota”:”32980”,
“ProductName”:”Ahsay Cloud Backup Suite”,
“MaxUsers”:”7100”,
“Port”:”8081”,
“RemainVMQuota”:”22000”,
“LicenseFile”:””,
“RemainObmQuota”:”5099”,
“Version”:”9.5.4.0”,
“NasQuota”:”2010”,
“EnableCbs”:true,
“UsedNasQuota”:”2”,
“Licensee”:”EvaluationOnly”,
“RemainMobileQuota”:”2000”,
“RemainOffice365Quota”:”4000”,
“UsedObmQuota”:”1”,
“UsedAcbRepQuota”:0,
“RemainAcbRepQuota”:2000,
“MaxObmUsers”:”5100”,
“RemainOpenDirectQuota”:”2000”,
“EnableUbs”:true,
“Mac”:”08-00-27-72-37-A8”,
“RemainAcbQuota”:”1999”,
“AcbRepQuota”:2000,
“UsedMobileQuota”:”0”,
“RemainNasQuota”:”2008”,
“UsedMobileV2Quota”:”20”,
“RemainExchangeMailboxQuota”:”2000”,
“RemainHypervisorSocketQuota”:”4000”,
“Key”:”62pMG-YPD6I-3ggaG-b5MCT-XX”,
“EnableHa”:false,
“ObmRepQuota”:5100,
“Description”:””,
“Ip”:”127.0.0.1”,
“MaxAcbUsers”:”2000”,
“UsedHypervisorSocketQuota”:”0”,
“DagUseObm”:0,
“UsedVMQuota”:”0”,
“MobileQuotaV2”:”33000”,
“AcbUseObm”:0,
“UsedExchangeMailboxQuota”:”0”,
“RemainObmRepQuota”:5100,
“UsedAcbQuota”:”1”,
“OpenDirectQuota”:”2000”,
“LicType”:4,

www.ahsay.com AhsayCBS API Guide | 63 of 450

 “UseProxy”:false,
“SupExpDate”:”12/31/2023”,
“LicTypeName”:”OEM License”,
“VMQuota”:”22000”,
“Office365Quota”:”4000”,
“AcbUseObmRep”:0,
“BrandedProductName”:””,
“UsedOffice365Quota”:”0”,
“ExchangeMailboxQuota”:”2000”,
“DateFormat”:”MM/dd/yyyy”,
“MaxQuota”:”UNLIMITED”,
“UsedOpenDirectQuota”:”0”,
“UsedObmRepQuota”:0
}

www.ahsay.com AhsayCBS API Guide | 64 of 450

GETREPLICATIONMODE

This API can be used to retrieve the current replication status on the backup server.

This setting can be found on the AhsayCBS web console at:

Monitoring > Replication Logs

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetReplicationMode.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API,
or Read-Only API role.
SysPwd String Password matching SysUser.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data ConfigData Contains particulars of replication settings.
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

REPLICATIONDATA

KEY TYPE DESCRIPTIONS

Enable Boolean Enable / Disable of the replication.
Replicators Array of Shows details of all Replicators enlisted in the Backup
Replicator Server.

www.ahsay.com AhsayCBS API Guide | 65 of 450

REPLICATOR

KEY TYPE DESCRIPTIONS

LoginName String Client user name.
BackupSetID String The 13-digit backup set ID.
Mode String The value can be any one of the following:
RESYNC
REPLAY
PENDING
SLEEPING
File String The file that is currently replicating.

EXAMPLE

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
}

OUTPUT
{
“Status”:”OK”,
“Data”:{
“Enable”:true,
“Replicators”:[
{
“LoginName”:”userA”,
“File”:””,
“BackupSetID”:”1463141188151”,
“Mode”:”RESYNC”,
}
]
}
}

www.ahsay.com AhsayCBS API Guide | 66 of 450

ADDPREDEFINEDDESTINATION
This API can be used to add (create) a predefined destination on the backup server.

This setting can be found on the AhsayCBS web console at:

System Settings > Basic > Predefined Destinations

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddPredefinedDestination.do
AVAILABLE SINCE VERSION:
9.7
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin, API,
or RO API role.
SysPwd String Password matching SysUser.
Type String The type of the predefined destination, please use one
of the available type within the set provided in the table.
“Destination Type”.
DestinationName String The name of the predefined destination, if not provided,
the name will be auto-generated by the server.
DestinationSettings JSON The settings for the predefined destination, the
Object underlying parameters are specific to each destination
type. Please refer to the tables labeled with
“DestinationSettings (DESTINATION_TYPE)” for the
correct format of each destination type.
Owner String The owner administrator name of this newly added
predefined destination, defaults to ADMIN.

www.ahsay.com AhsayCBS API Guide | 67 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message; it only appears if “status” displays “Error”.
DestinationID String The ID for the newly added predefined destination, available
only for successful addition.
ExptType String The type of exception (Java-class name), available only in
error response body.

JSON OBJECTS

ADDITIONAL FIELDS (TO MERGE WITH RETURN VALUES ON ERROR)

KEY TYPE DESCRIPTIONS

InstructionID String The instruction id of this error, please refer to the
table “Instruction ID” for the value set.
AvailableOptions JSON Object The available options for certain missing parameters,
this field will be set when InstructionID equals
MISSING_PARAMETER.
OAuthUrl String The authorization url for retrieving the authorization
token, this field will be set when InstructionID equals
OAUTH_OPEN_URL.
Message String The detailed message of this error.

DESTINATION TYPE

TYPE DESCRIPTIONS
FTP An FTP-based destination.
SFTP An SFTP-based destination.
Local A local destination (local to the client).
OBS A destination (“User Home”) provided by the CBS server.
Pooled A destination pool.
RPS Used for replication.
Aliyun Alibaba Aliyun
AWSCompatible AWS Compatible
Azure Microsoft Azure
Backblaze Backblaze

www.ahsay.com AhsayCBS API Guide | 68 of 450

 CTYun China Telecom CTYun
Dropbox Dropbox
GCS Google Cloud Service
GDrive Google Drive
OneDrive Microsoft OneDrive
OneDrive4Biz Microsoft OneDrive for Business
OpenStack OpenStack
Rackspace Rackspace
S3 Amazon S3
Wasabi Wasabi

INSTRUCTION ID

VALUE DESCRIPTIONS
MISSING_PARAMETER Returned from a failed addition of a predefined destination, due to a missing
parameter with predefined value set. If this ID is encountered, please refer to
the RESPONSE_BODY. Message for instructions and
RESPONSE_BODY_AvailableOptions for the value set.
OAUTH_OPEN_URL Returned from a failed addition of predefined destination, due to undefined
or empty authorization token in the request body. If encountered, please
refer to RESPONSE_BODY. Message for instructions and
RESPONSE_BODY.OAuthUrl for the url to kick start the authorization
procedure.

www.ahsay.com AhsayCBS API Guide | 69 of 450

DESTINATION SETTINGS (JSON OBJECTS)

OBS

KEY TYPE DESCRIPTIONS

Immutable Boolean Whether stored data cannot be changed, modified,
or deleted after being created; defaults to false.
TempDelete Boolean Whether temporary delete is enabled for AhsayCBS
destination; defaults to false.
TempDeleteDate String Temporary delete date in yyyy-mm-dd format;
defaults to tomorrow’s date.
Hour Integer The end hour of temporary delete. “0”, “1”…”23” can
be set. Defaults to 0
Minute Integer The end minute of temporary delete. “0”, “1”..”59”
can be set. Defaults to 0

FTP

KEY TYPE DESCRIPTIONS

Host String The hostname of the FTP server.
Port String The port of the FTP server.
Username String The username of the FTP account.
Password String The password of the FTP account.
Ssl Boolean Whether the FTP connection will be in SSL mode.

SFTP

KEY TYPE DESCRIPTIONS

Host String The hostname of the SFTP server.
Port String The port of the SFTP server.
Username String The username of the SFTP account.
Password String The password of the SFTP account.

www.ahsay.com AhsayCBS API Guide | 70 of 450

LOCAL

KEY TYPE DESCRIPTIONS

TopDir String The path to the target directory can be network
locations.
Username String The username of the SFTP account.
Password String The password of the SFTP account.

POOLED

KEY TYPE DESCRIPTIONS

DestinationIDList JSON Array An array of predefined destination ids, all of the ids
should reference any existing predefined destination
within the CBS server.

RPS

KEY TYPE DESCRIPTIONS

Host String The hostname of the target replication CBS server.
Port String The port of the target replication CBS server.
Username String The username of the replication account created
within the replication CBS server.
Password String The password of the replication account created
within the replication CBS server.
Ssl Boolean Whether the connection uses SSL, defaults to “false”.

ALIYUN

KEY TYPE DESCRIPTIONS

AccessKey String The access key.
SecretKey String The secret key.
Location String The location of this destination, please refer to the
Aliyun Locations for the value set.
BucketName String The bucket name, optional.

www.ahsay.com AhsayCBS API Guide | 71 of 450

ALIYUN LOCATIONS

LOCATION VALUE
China (Hangzhou) oss-cn-hangzhou
China (Shanghai) oss-cn-shanghai
China (Qingdao) oss-cn-qingdao
China (Beijing) oss-cn-beijing
China (Zhangjiakou) oss-cn-zhangjiakou
China (Hohhot) oss-cn-huhehaote
China (Ulanqab) oss-cn-wulanchabu
China (Shenzhen) oss-cn-shenzhen
China (Heyuan) oss-cn-heyuan
China (Guangzhou) oss-cn-guangzhou
China (Chengdu) oss-cn-chengdu
China (Hong Kong) oss-cn-hongkong
Singapore oss-ap-southeast-1
Australia (Sydney) oss-ap-southeast-2
Malaysia (Kuala Lumpur) oss-ap-southeast-3
Indonesia (Jakarta) oss-ap-southeast-5
Japan (Tokyo) oss-ap-northeast-1
India (Mumbai) oss-ap-south-1
Germany (Frankfurt) oss-eu-central-1
UK (London) oss-eu-west-1
US (Silicon Valley) oss-us-west-1
US (Virginia) oss-us-east-1
UAE (Dubai) oss-me-east-1

www.ahsay.com AhsayCBS API Guide | 72 of 450

AWSCOMPATIBLE

KEY TYPE DESCRIPTIONS

Host String The hostname of the AWS Compatible service.
Port String The port of the AWS Compatible service.
Immutable Boolean Whether stored data cannot be changed, modified,
or deleted after being created; defaults to false.
AccessKey String The access key.
SecretKey String The secret key.
BucketName String The bucket name.

AZURE

KEY TYPE DESCRIPTIONS

StorageAccountName String The storage account name.
AccessKey String The access key of this storage account.
Region String The region of this destination, please refer to the
Azure Regions section for the value set.
Immutable Boolean Whether stored data cannot be changed, modified,
or deleted after being created; defaults to false.

AZURE REGIONS

REGION VALUE
Global GLOBAL
China CHINA
Germany GERMANY
USGOV USGOV

BACKBLAZE

KEY TYPE DESCRIPTIONS

KeyId String The key id.
ApplicationKey String The application key.
Immutable Boolean Whether stored data cannot be changed, modified,
or deleted after being created; defaults to false.
BucketName String The bucket name, optional.

www.ahsay.com AhsayCBS API Guide | 73 of 450

CTYUN

KEY TYPE DESCRIPTIONS

AccessKey String The access key.
AccessSecretKey String The access secret key.

DROPBOX

KEY TYPE DESCRIPTIONS

AccessToken String The authorization token retrieved from the Dropbox
site, when this field is undefined or empty, the
request will fail, with RESPONSE_BODY. InstructionID
set to OAUTH_OPEN_URL and RESPONSE_BODY.
OAuthUrl set to the url for kick-starting the
authorization procedure.

GOOGLE CLOUD STORAGE

KEY TYPE DESCRIPTIONS

AccessKey String The access key.
Secret String The access secret key.
Immutable Boolean Whether stored data cannot be changed, modified,
or deleted after being created; defaults to false.
LocationType String The location type of this destination, please refer to
the GCS Location Types section for the value sets.
Location String The location of this destination, please refer to the
table GCS Locations for the value set.
StorageClass String The storage class name of this destination, please
visit this page for the latest documentation.
BucketName String The bucket name, optional

www.ahsay.com AhsayCBS API Guide | 74 of 450

GCS LOCATION TYPES

TYPE VALUE
Region REGION
Multi-Region MULTI_REGION
Dual-Region DUAL_REGION

GCS LOCATIONS

REGION VALUE
Montréal NORTHAMERICA-NORTHEAST1L
Iowa US-CENTRAL1
South Carolina US-EAST1
Northern Virginia US-EAST4
Oregon US-WEST1
Los Angeles US-WEST2
Salt Lake City US-WEST3
Las Vegas US-WEST4
São Paulo SOUTHAMERICA-EAST1
Warsaw EUROPE-NORTH1
Belgium EUROPE-WEST1
London EUROPE-WEST2
Frankfurt EUROPE-WEST3
Netherlands EUROPE-WEST4
Zurich EUROPE-WEST6
Taiwan ASIA-EAST1
Hong Kong ASIA-EAST2
Tokyo ASIA-NORTHEAST1
Osaka ASIA-NORTHEAST2
Seoul ASIA-NORTHEAST3
Mumbai ASIA-SOUTH1
Singapore ASIA-SOUTHEAST1
Jakarta ASIA-SOUTHEAST2
Sydney AUSTRALIA-SOUTHEAST1

www.ahsay.com AhsayCBS API Guide | 75 of 450

GOOGLE DRIVE

KEY TYPE DESCRIPTIONS

Token String The authorization token retrieved from Google Drive
site, when this field is undefined or empty, the
request will fail, with RESPONSE_BODY. InstructionID
set to OAUTH_OPEN_URL and RESPONSE_BODY.
OAuthUrl set to the url for kick-starting the
authorization procedure.

MICROSOFT ONEDRIVE

KEY TYPE DESCRIPTIONS

Token String The token for the destination, if the provided value is
undefined or empty, the request will fail, with
RESPONSE_BODY. InstructionID set to
OAUTH_OPEN_URL and RESPONSE_BODY. OAuthUrl
set to the url for kick-starting the authorization
procedure.

MICROSOFT ONEDRIVE4BIZ

KEY TYPE DESCRIPTIONS

Token String The token for the destination, if the provided value is
undefined or empty, the request will fail, with
RESPONSE_BODY. InstructionID set to
OAUTH_OPEN_URL and RESPONSE_BODY. OAuthUrl
set to the url for kick-starting the authorization
procedure.
Region String The region of the destination, please refer to the
section OneDrive4Biz Regions for the value set.

ONEDRIVE4BIZ REGIONS

REGION VALUE
Global GLOBAL
China CHINA
Germany GERMANY

www.ahsay.com AhsayCBS API Guide | 76 of 450

OPENSTACK

KEY TYPE DESCRIPTIONS

Host String The hostname of the OpenStack service.
Port String The port of the Open Stack service.
Username String The username of the service account.
Password String The password of the service account.
Project String The project name for this destination. If the provided
value is undefined, RESPONSE_BODY. InstructionID
set to MISSING_PARAMETERS, please follow the
instruction provided in RESPONSE_BODY. Message to
select the project for this destination.

RACKSPACE

KEY TYPE DESCRIPTIONS

Username String The username of a Rackspace account.
ApiKey String The API key for accessing Rackspace APIs.
Region String The region name of the Rackspace service, please
refer to the Rackspace Regions section for the value
set.
ContainerName String The container name of this destination.

RACKSPACE REGIONS

REGION VALUE
Chicago ORD
Dallas Ft. Worth DFW
Hong Kong HKG
London LON
Northern Virginia IAD
Sydney SYD

www.ahsay.com AhsayCBS API Guide | 77 of 450

AMAZON S3

KEY TYPE DESCRIPTIONS

AccessKey String The access key.
SecretKey String The secret key.
Immutable Boolean Whether stored data cannot be changed, modified,
or deleted after being created; defaults to false.
Location String The location of this destination, please refer to
section Amazon S3 Locations for the value sets.
StorageClass String The storage class of this destination, please refer to
the Amazon S3 Storage Classes for the value sets.
BucketName String The bucket name, optional.

AMAZON S3 LOCATIONS

REGION VALUE
Africa (Cape Town) af-south-1
Asia Pacific (Hong Kong) ap-east-1
Asia Pacific (Mumbai) ap-south-1
Asia Pacific (Osaka-Local) ap-northeast-3
Asia Pacific (Seoul) ap-northeast-2
Asia Pacific (Singapore) ap-southeast-1
Asia Pacific (Sydney) ap-southeast-2
Asia Pacific (Tokyo) ap-northeast-1
Canada (Central) ca-central-1
China (Beijing) cn-north-1
China (Ningxia) cn-northwest-1
Europe (Ireland) eu-west-1
Europe (Frankfurt) eu-central-1
Europe (London) eu-west-2
Europe (Milan) eu-south-1
Europe (Stockholm) eu-north-1
AWS GovCloud (US-East) us-gov-east-1
AWS-GovCloud (US) us-gov-west-1
Middle East (Bahrain) me-south-1
South America (Sao Paulo) sa-east-1
US East (Ohio) us-east-2
US West (Northern California) us-west-2

www.ahsay.com AhsayCBS API Guide | 78 of 450

AMAZON S3 STORAGE CLASSES

TYPE VALUE DESCRIPTION

Standard STANDARD Ideal for performance sensitive use cases and
frequently accessed data. This is the default
storage class.
Standard – Infrequent STANDARD_IA (IA, for infrequent access) is optimized for long-
Access Storage lived and less frequently accessed data, for
example backups and older data where access
has diminished, but the use case still demands
high performance.
Intelligent – Tiering INTELLIGENT_TIERING Long-lived data with changing or unknown
Storage access patterns.
One Zone – Infrequent ONEZONE_IA Long-lived, infrequently accessed, non-critical
Access Storage data.
Reduced Redundancy REDUCED_REDUNDANCY (RSS) Storage class is designed for non-critical,
Storage (RRS) reproducible data stored at lower levels of
redundancy than the STANDARD storage class,
which reduces storage costs.

WASABI

KEY TYPE DESCRIPTIONS

AccessKey String The access key.
SecretKey String The secret key.
Immutable Boolean Whether stored data cannot be changed, modified,
or deleted after being created; defaults to false.
BucketName String The bucket name, optional.
Location String The location of the Wasabi service, please refer to
the Wasabi Locations section for the value sets.

WASABI LOCATIONS

REGION VALUE
Toronto ca-central-1
Oregon us-west-1
Plano, Texas us-central
Northern Virginia us-east-1
Southern Virginia us-east-2
Amsterdam eu-central-1

www.ahsay.com AhsayCBS API Guide | 79 of 450

Frankfurt eu-central-2
London eu-west-1
Paris eu-west-2
Tokyo ap-northeast-1
Osaka ap-northeast-2
Singapore ap-southeast-1
Sydney ap-southeast-2

EXAMPLES

EXAMPLE 1: CREATING GOOGLE DRIVE PREDEFINED DESTINATION

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“Type”:”GDrive”,
“SkipVerify”:false,
“DestinationSettings”:{
“Token”:9/abc0e-
g5bc2XX2jepVtYRSiA6J4Q03rgVPfssYVu3xhyl9PiHqkiabmwM3i”
}
}
OUTPUT
{
“Status”:”OK”,
“DestinationID”:”-1620712268943”
}

www.ahsay.com AhsayCBS API Guide | 80 of 450

EXAMPLE 2: INVALID TOKEN FOR GOOGLE DRIVE PREDEFINED DESTINATION

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“Type”:”GDrive”,
“DestinationSettings”:{
“Token”:”FAKE”
}
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[GDriveManager$GDriveAuthorization.getOAuth2TokensByTempKey]
Failed to get Oauth2Tokens after retrieved from GDrive”,
“ExptType”:”java.land.Exception”
}

EXAMPLE 3: CREATING CBS (OBS) DESTINATION WITH NO MFA SETUP

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“Type”:”OBS”,
“DestinationSettings”:{
“Immutable”:true,
“TempDelete”:true,
“TempDeleteDate”:”2023-08-25”,
“Hour”:6,
“Minute”:13
}
}
OUTPUT
{
“Status”:”Error”,
“Message”:”Please setup 2FA devices to proceed with adding immutable
destination.”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 81 of 450

2.3 SYSTEM USER
The System User subcategory has APIs for the user to use for configuring details regarding the
system user logged in to AhsayCBS. This includes other functions such as adding new users,
removing them, and authorizing which users have admin rights or not. Additionally, already
existing users can be listed for the API user’s benefit.

ADDSYSUSER
This API can be used to add a system user(s).

This setting can be found on the AhsayCBS web console at:

System Settings > Basic > Administrative Access

NOTE
Starting with CBS v8.3.4.0 affecting all APIs, if AhsayCBS Administrative Access feature is enabled, users may
see the error message:
“Your password has expired and must be changed. Please update in web console or by UpdateSysUser API”
This message may appear if a system user’s password is expired when calling any API except
UpdateSysUser.do. AddSysUser.do and UpdateSysUser.do may see error messages regarding password
complexity when complexity settings are enabled.
This setting can be found on the AhsayCBS web console at:
System Settings > Basic > Administrative Access > Authentication > Password.

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddSysUser.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
LoginName String Login name of the system user.
Password String Password in plaintext or hashed password. If passing
hashed, include PasswordHashed key. Use
ListSystemUsers.do to lookup HashedPwd.
PasswordHashed Boolean An indicator for account’s input password if hashed or
not.

www.ahsay.com AhsayCBS API Guide | 82 of 450

 Default “false” if NOT in request.
NOTE: If PasswordHashed is set to false, the Password
will be hashed and stored. If set as true, Password will
be stores as-is. If PasswordHashed is set to true and not
using a hashed password, then users will not be able to
login to the system.
Hash Algorithm: Plaintext input > encode Hash algorithm
SHA-256 > output Hex bytes > encode Hex-Base64 >
Hashed text output.
Role String Role of the system account
The value can be set to one of the following:
ADMIN
READ_ONLY_ADMIN
RESELLER
API_ONLY
Hostname String Mandatory if “Role” is set to RESELLER.
IP String Mandatory if “Role” is set to RESELLER.
Note: The IP address must include the HTTPS connector
port, for example: 0.0.0.0:443.
IsShowRebrandingPages Boolean Corresponding to the three checkboxes on AhsayCBS UI
when edit a sub-admin applies only if “Role” is set to
RESELLER.
IsSendConsolidatedReport Boolean Corresponding to the three checkboxes on AhsayCBS UI
when edit a sub-admin applies only if “Role” is set to
RESELLER.
IsFreeTrialOfferAllowed Boolean True = Allow sub-admin accounts to configure Free Trial
options and allow to set users to Trial user type.
Corresponding to the three checkboxes on AhsayCBS UI
when edit a sub-admin applies only if “Role” is set to
RESELLER.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is “Error”.
ExptType String The type of exception, will only be displayed if the status is
“Error”.

www.ahsay.com AhsayCBS API Guide | 83 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“LoginName”:”api_user”,
“Password”:”qWeRtY123456!@#$%”,
“PasswordHashed”:”false”,
“Role”:”API_ONLY”
}
OUTPUT
{
“Status”:”OK”,
}
OUTPUT 2 – If another user with the same user name exists already
{
“Status”:”Error”,
“Message”:”Name is already used. Please use another name.”
“ExptType”:”java.lang.Exception”
}

EXAMPLE 2 – INPUT ISSENDCONSOLIDATEDREPORT FOR ROLE = ADMIN

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“LoginName”:”AdminTom”,
“Password”:”qWeRtY123456!@#$%”,
“Role”:”ADMIN”,
“IsSendConsolidatedReport”:”true”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”Update consolidated report setting for ‘Admin’ system user
through ‘UpdateServerConfig.do’”,
“ExptType”:”java.land.Exception”
}

www.ahsay.com AhsayCBS API Guide | 84 of 450

EXAMPLE 3 – INPUT ISSHOWREBRANDINGPAGES FOR ROLE = ADMIN

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“LoginName”:”AdminTom”,
“Password”:”qWeRtY123456!@#$%”,
“Role”:”ADMIN”
“IsShowRebrandingPages”:”false”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”Invalid parameter IsShowRebrandingPages for ADMIN system
user”,
“ExptType”:”java.lang.Exception”
}

www.ahsay.com AhsayCBS API Guide | 85 of 450

UPDATESYSUSER
This API can be used to update the password and status of a system user.

This setting can be found on the AhsayCBS web console at:

System Settings > Basic > Administrative Access

NOTE
Starting with CBS v8.3.4.0 affecting all APIs, if CBS Administrative Access feature is enabled, users may see
the error message:
“Your password has expired and must be changed Please update in web console of by UpdateSysUser API”
This message may appear if a system user’s password is expired when calling any API except
UpdateSysUser.do. AddSysUser.do and UpdateSysUser.do may see error messages regarding password
complexity when complexity settings are enabled.
This setting can be found on the AhsayCBS web console at:
System Settings > Basic > Administrative Access > Authentication > Password

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateSysUser.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
LoginName String Login name of the system user.
Password String Password in plaintext or hashed password. If passing
hashed, include PasswordHashed key. Use
ListSystemUsers.do to lookup HashedPwd.
Status String “SUSPENDED” / “ENABLED”
PasswordHashed Boolean An indicator for account’s input password is hashed or
not.
Default “false” if NOT in request.
NOTE: If PasswordHashed is set to false, the Password
will be hashed and stored. If set as true, Password will
be stores as-is. If PasswordHashed is set to true and not
using a hashed password, then users will not be able to
login to the system.
Hash Algorithm: Plaintext input > encode Hash algorithm

www.ahsay.com AhsayCBS API Guide | 86 of 450

 SHA-256 > output Hex bytes > encode Hex-Base64 >
Hashed text output.
IsShowRebrandingPages Boolean Corresponding to the three checkboxes on AhsayCBS UI
when edit a sub-admin applies only if “Role” is set to
RESELLER.
IsSendConsolidatedReport Boolean Corresponding to the three checkboxes on AhsayCBS UI
when edit a sub-admin applies only if “Role” is set to
RESELLER.
IsFreeTrialOfferAllowed Boolean True = Allow sub-admin accounts to configure Free Trial
options and allow to set users to Trial user type.
Corresponding to the three checkboxes on AhsayCBS UI
when edit a sub-admin applies only if “Role” is set to
RESELLER.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is “Error”.
ExptType String The type of exception, will only be displayed if the status is
“Error”.

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“LoginName”:”admin123”,
“Password”:”changepassword”,
“PasswordHashed”:”false”
}
OUTPUT
{
“Status”:”OK”,
}

www.ahsay.com AhsayCBS API Guide | 87 of 450

EXAMPLE 2

INPUT – Missing the LoginName parameter

{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“Password”:”changepassword”,
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter LoginName is null/empty!”
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

EXAMPLE 3

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“LoginName”:”admin123”,
“Password”:”changepassword”,
“Status”:”ENABLED”
}
OUTPUT
{
“Status”:”OK”,
}

EXAMPLE 4

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“LoginName”:”admin123”,
“Password”:”changepassword”,
“Status”:”LOCKED”
}

www.ahsay.com AhsayCBS API Guide | 88 of 450

OUTPUT
{
“Status”:”Error”,
“Message”:”Invalid value. ‘Status’ must be ‘ENABLED’ or ‘SUSPENDED’”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

EXAMPLE 5

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“LoginName”:”admin123”,
“Password”:”changepassword”,
“Status”:0
}
OUTPUT
{
“Status”:”Error”,
“Message”:”JSONObject\”Status\”\not a string”,
“ExptType”:”org.json.JONException”
}

EXAMPLE 6

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter LoginName is null/empty!”
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 89 of 450

REMOVESYSUSER
This API can be used to remove a system user.

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

System Settings > Basic > Administrative Access

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemoveSysUser.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
RemoveLoginName String Login name of the system user to be removed.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the status
is “Error”.

www.ahsay.com AhsayCBS API Guide | 90 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“RemoveLoginName”:”dummyAdmin”
}
OUTPUT
{
“Status”:”OK”,
}

EXAMPLE 2

INPUT – If the system user does not exist

{
“SysUser”:”sample”,
“SysPwd”:”sample”,
“RemoveLoginName”:”nosuchuser”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”System user ‘nosuchuser’ does not exist”,
“ExptType”:”org.json.JSONException”
}

www.ahsay.com AhsayCBS API Guide | 91 of 450

AUTHSYSTEMUSER
This API can be used to check whether the SysUser has admin right or not.

If the user type of the SysUser is Read-only Admin or API, an error status will be returned.

This setting can be found on the AhsayCBS web console at:

System Settings > Basic > Administrative Access

URL
https://CBS.EXAMPLE.COM/obs/api/json/AuthSystemUser.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 92 of 450

EXAMPLES

EXAMPLE 1: FOR SYSUSER WITH ADMIN ROLE

INPUT
{
“SysUser”:”Admin”,
“SysPwd”:”password”,
}
OUTPUT
{
“Status”:”OK”,
}

EXAMPLE 2: FOR SYSUSER WITH READ-ONLY ADMIN ROLE

INPUT
{
“SysUser”:”Read-Only Admin”,
“SysPwd”:”sample”
}

OUTPUT
{
“Status”:”Error”,
“Message”:”Incorrect system username/password”,
“ExptType”:”com.ahsay.obs.core.dbs.c”
}

www.ahsay.com AhsayCBS API Guide | 93 of 450

LISTSYSTEMUSERS
This API lists the information of all system users.

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

System Settings > Basic > Administrative Access

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListSystemUsers.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
RoleOnly Boolean List the role of system users only (SystemUserRole).
Host String AhsayCBS’s URL. It is required for calling API from
Redirector only.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array of If RoleOnly is true, an array of SystemUserRole is
SystemUserRole returned. Otherwise, an array of SystemUser is
or Array of returned.
SystemUser
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 94 of 450

JSON OBJECTS

SYSTEMUSERROLE

KEY TYPE DESCRIPTIONS

Name String Name of User Role
Role String The value can be any one of the following:
ADMIN
READ_ONLY_ADMIN
RESELLER
API_ONLY

SYSTEMUSER

KEY TYPE DESCRIPTIONS

Name String Name of the User
Role String The value can be any one of the following:
ADMIN
READ_ONLY_ADMIN
API_ONLY
Status String “SUSPENDED” or “ENABLED”
HashedPwd String Encrypted (Hashed) password of a user
IsShowRebrandingPages Boolean True=Show Branding UI
IsSendConsolidatedReport Boolean True=Send Consolidated Reports
IsFreeTrialOfferAllows Boolean True=Free Trial option is allowed
False=Free Trial option hidden, users cannot be set
to Trial user type.

www.ahsay.com AhsayCBS API Guide | 95 of 450

EXAMPLE

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456”
}
OUTPUT 1
{
“Status”:”OK”,
“Data”:[
{
“Role”:”ADMIN”,
“Status”:”ENABLED”,
“HashedPwd”:”ggeRi1mrAu37jPPCb6q6sRyBRlz/VxUgHbso6jqZu0I=”,
“IsShowRebrandingPages”:false,
“Name”:”system”,
“IsFreeTrialOfferAllowed”:true,
}
]
}

www.ahsay.com AhsayCBS API Guide | 96 of 450

2.4 GROUP POLICY
This subcategory deals with configurations for Group Policies and User Groups, including the
addition and deletion of either one, as well as the modification of already existing Group
Policies or User Groups relative to their effects on Users.

ADDUSERGROUP
This API lets you add a new User Group and allocate users to it.

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

Backup/Restore > Users, Groups & Policies > User Group

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddUserGroup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
UserGroupName String Group name.
Type String The value can be any one of the following:
backup-user (Default value)
UserIdList String Multiple login names, separated by commas, are
accepted. For example; user1, user2, user3.
PolicyIDList Array of Array of policy ID.
String

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is “Error”.
ExptType String The type of exception, will only be displayed if the status is
“Error”.
ID String ID of User Group

www.ahsay.com AhsayCBS API Guide | 97 of 450

JSON OBJECTS

EDITBILLINGCONTACTBEAN

KEY TYPE DESCRIPTIONS

ContactId String ID of contact.
Name String Name of contact.
Email String Email of contact.
Address String Address of contact.
Company String Company of contact.
Website String Website of contact.
Phone1 String First of two contact numbers of contact.
Phone2 String Second of two contact numbers of contact.

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“UserGroupName”:”user-group”
}
OUTPUT 1
{
“Status”:”OK”,
“ID”:”1447039919940”
}
OUTPUT 2 – User Group already in use
{
“Status”:”Error”,
“Message”:”The user group name is already in use”,
“ExptType”:”java.lang.Exception”
}

www.ahsay.com AhsayCBS API Guide | 98 of 450

EXAMPLE 2: ADD USER GROUP IN ASSIGN POLICY

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”qWeRtY123456!@#$%”,
“UserGroupName”:”test-usergroup”,
“PolicyIDList”:[“1398011529749”]
}
OUTPUT 1
{
“Status”:”OK”,
“ID”:”1447039919940”
}

www.ahsay.com AhsayCBS API Guide | 99 of 450

DELETEPOLICYGROUP
This API allows you to delete a policy group.

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

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

URL
https://CBS.EXAMPLE.COM/obs/api/json/DeletePolicyGroup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
ID String ID of the policy group.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

EXAMPLE

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”abc123”,
“ID”:”1496989829495”
}

OUTPUT 1
{
“Status”:”OK”,
}

www.ahsay.com AhsayCBS API Guide | 100 of 450

DELETEPOLICYGROUPFROMUSERGROUP
This API allows you to deallocate an assigned policy group within a user group.

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

Backup / Restore > Users, Groups & Policies > User Group > % User Group Name% >
Assigned Policy

URL
https://CBS.EXAMPLE.COM/obs/api/json/DeletePolicyGroupFromUserGroup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
UserGroupID String ID of User Group.
PolicyGroupID String ID of Policy Group.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 101 of 450

EXAMPLE

INPUT
{
“SysUser”:”api”,
“SysPwd”:”pwd”,
“UserGroupID”:”1497233669967”,
“PolicyGroupID”:”1497233409042”
}
OUTPUT 1
{
“Status”:”OK”
}
OUTPUT 2 – Policy group does not exist
{
“Status”:”Error”,
“Message”:”Policy group does not exist”,
“ExptType”:”org.json.JSONException”
}

www.ahsay.com AhsayCBS API Guide | 102 of 450

DELETEUSERFROMUSERGROUP
This API allows you to delete users in a user group.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > User Profile
> User Group

URL
https://CBS.EXAMPLE.COM/obs/api/json/DeleteUserFromUserGroup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
ID String ID of User Group.
UserIdList String Multiple login names, separated by commas, are
accepted. For example: user1, user2, user3.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 103 of 450

EXAMPLE

INPUT
{
“SysUser”:”api”,
“SysPwd”:”pwd”,
“ID”:”1497233669967”,
“UserIdList”:”1497233409042, 1496977596356”
}
OUTPUT 1
{
“Status”:”OK”,
}
OUTPUT 2 – USER DOES NOT EXIST
{
“Status”:”Error”,
“Message”:”[UserCacheManager.NoSuchUserExpt] User ‘1497233409042’ not
found.”,
“ExptType”:”com.ahsay.obs.core.dbs.Y”
}

www.ahsay.com AhsayCBS API Guide | 104 of 450

DELETEUSERGROUP
This API allows you to delete a user group and all its information.

The related settings can be found on the AhsayCBS web console.

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > User Profile
> User Group

URL
https://CBS.EXAMPLE.COM/obs/api/json/DeleteUserGroup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
ID String ID of User Group.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 105 of 450

EXAMPLE

INPUT
{
“SysUser”:”api_user”,
“SysPwd”:”abc123”,
“ID”:”1497232492006”
}
OUTPUT 1
{
“Status”:”OK”,
}
OUTPUT 2 – User does not exist
{
“Status”:”Error”,
“Message”:”[Error] Parameter UserGroupID, 1497232492006 does not
exist.”,
“ExptType”:”com.ahsay.obs.core.dbs.Y”
}

www.ahsay.com AhsayCBS API Guide | 106 of 450

LISTPOLICYGROUPS (V1, V2)
This API can be used to retrieve the group policy settings of a backup user.

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

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.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
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.

www.ahsay.com AhsayCBS API Guide | 107 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array (data of If parameter PolicyGroupNameOnly is true, only data
NameInfo or under NameInfo is returned. Otherwise, PolicyGroup is
PolicyGroup) returned.
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

JSON OBJECTS

NAMEINFO

KEY TYPE DESCRIPTIONS

PolicyGroupID String ID of Policy Group.
PolicyGroupName String Name of Policy Group.

POLICYGROUP

KEY TYPE DESCRIPTIONS

PreemptedValues Array
Type String The value can be one of the following:
BACKUP_USER
SYSTEM_USER
Owner String System User that owns the Policy Group.
GuiSettings Array Array for GUI settings of Policy Group.
PreemptedBackupSetSettings Array Array for Preempted Backup Set Settings of Policy
Group.
BackupSetSettings Array Array for Backup Set Settings of Policy Group.
UserSettings Array Array for User settings of Policy Group.
MobileSettings Array Array of Mobile Setting of Policy Group.
DefaultValues Array Array of Default Values for settings of Policy Group.
ID String ID of Policy Group.
Name String Name of Policy Group.

www.ahsay.com AhsayCBS API Guide | 108 of 450

OTHER PARAMETERS UNDER POLICY GROUP

PREEMPTEDVALUES

KEY TYPE DESCRIPTIONS

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 Open Direct 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 Shadow Protect 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 CDP settings.
SourceShortcutSettingsList Array Array for Source Shortcut settings.

www.ahsay.com AhsayCBS API Guide | 109 of 450

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.

GRANULARRESTORESETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

VMWARESETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

VMWARESETTING

KEY TYPE DESCRIPTIONS

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 VMware Version.
AutoEnableCBT Boolean Automatically enabled Changed Block Tracking when
AhsayOBM detects VDDK mode.
AppliedValueSettings Array See AppliedValueSettings.

www.ahsay.com AhsayCBS API Guide | 110 of 450

OPENDIRECTSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

APPLIEDVALUESETTINGS

KEY TYPE DESCRIPTIONS

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
override
Name String Name of Applied Value.
Os String This value can be empty, or one of the following:
windows
mac
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.

www.ahsay.com AhsayCBS API Guide | 111 of 450

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)
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 (Failover Cluster)
Microsoft Hyper-V Server 2012 R2
Microsoft Hyper-V Server 2012 R2 (Failover
Cluster)

VOLUMESHADOWCOPYSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

www.ahsay.com AhsayCBS API Guide | 112 of 450

VOLUMESHADOWCOPYSETTING

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
Id String Array list of settings.
AppliedValueSettings Array See AppliedValueSettings

ALLOWEDIPSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

ALLOWEDIPSETTING

KEY TYPE DESCRIPTIONS

Id String ID of setting.
AllowedIPList Array Array List of Allowed IPs.
AppliedValueSettings Array See AppliedValueSettings.

ALLOWEDIP

KEY TYPE DESCRIPTIONS

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 DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

FOLLOWLINKSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

www.ahsay.com AhsayCBS API Guide | 113 of 450

FOLLOWLINKSETTING

KEY TYPE DESCRIPTIONS

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

INFILEDELTASETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

INFILEDELTASETTING

KEY TYPE DESCRIPTIONS

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 for block size.
DefaultDeltaType String Delta Type.
AppliedValueSettings Array See AppliedValueSettings.

WEEKLYINFILEDELTASCHEDULE

KEY TYPE DESCRIPTIONS

Day Array The array contains 7 Strings, representing the delta
type from Sunday to Saturday.
The values of the Strings can be one of the following:
F (For full backup)
D (For differential delta)
I (For incremental delta)

www.ahsay.com AhsayCBS API Guide | 114 of 450

MONTHLYINFILEDELTASCHEDULE

KEY TYPE DESCRIPTIONS

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
Saturday
Occurrence String The value can be one of the following:
First
Second
Third
Fourth
Last
Month Array The array consists of 12 Strings, representing the
delta type from January to December.
The values of the Strings can be one of the following:
F (For full backup)
D (For differential delta)
I (For incremental delta)

COMPRESSIONSSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.
OverwriteDefaultCompression Boolean If it is true, overwrite default compression type to
“Optimal 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 param.

www.ahsay.com AhsayCBS API Guide | 115 of 450

COMPRESSIONSSETTING

KEY TYPE DESCRIPTIONS

Id String ID of setting
Type String The value can be empty, or one of the following:

“GzipDefaultCompression” (Normal)
“GzipBestSpeedCompression” (Fast)
“SnappyDefaultCompression” (Optimal for local)
AppliedValueSettings Array See AppliedValueSettings.

WINUSERAUTHSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

WINUSERAUTHSETTING

KEY TYPE DESCRIPTIONS

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 DESCRIPTIONS

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.Office
365SourceShortcutSettings
WindowsOutlook String 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.

www.ahsay.com AhsayCBS API Guide | 116 of 450

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 MyDocuments.
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 OneDrive.
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 DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

MSWINDOWSSYSTEMSTATESETTING
KEY TYPE DESCRIPTIONS
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 AhsayCBS version where the setting was made.

www.ahsay.com AhsayCBS API Guide | 117 of 450

BackupTarget String Temporary location for the system backup.
AppliedValueSettings Array See AppliedValueSetting.

DESTINATIONSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

DESTINATIONSETTING

KEY TYPE DESCRIPTIONS

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 DESCRIPTIONS
Id String ID of the setting.

BANDWIDTHCONTROLSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

BANDWIDTHCONTROLSETTING
KEY TYPE DESCRIPTIONS
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
share
AppliedValueSettings Array See AppliedValueSettings.

www.ahsay.com AhsayCBS API Guide | 118 of 450

BANDWIDTHCONTROL
KEY TYPE DESCRIPTIONS
Name String Name of the Bandwidth Control.
Id String ID of the setting.
StartDay Long Starting Day of the Bandwidth Control.
Sunday = 1
Monday = 2
Tuesday = 3
Wednesday = 4
Thursday = 5
Friday = 6
Saturday = 7
StartHour Long Shows the 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 where bandwidth control ends. Similar values as
StartDay.
EndHour Long Ending the starting 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 DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

NAMESETTING
KEY TYPE DESCRIPTIONS
Id String ID of the setting.
Name String Name of the setting.
AppliedValueSettings Array See AppliedValueSettings.

www.ahsay.com AhsayCBS API Guide | 119 of 450

MYSQLSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

MYSQLSETTING
KEY TYPE DESCRIPTIONS
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 used in tandem with Username to Login.
MysqldumpPath String Path to mysqldump file.
Version String AhsayCBS version where the setting was made.
AppliedValueSettings Array See AppliedValueSettings.

FILEPERMISSIONSSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

FILEPERMISSIONSETTING
KEY TYPE DESCRIPTIONS
Enable Boolean Enable / Disable
Id String ID of the setting.
AppliedValueSettings Array See AppliedValueSettings.

www.ahsay.com AhsayCBS API Guide | 120 of 450

RETENTIONPOLICYSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean Enable / Disable
List Array Array list of settings.

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

ADVANCEDRETENTIONPOLICY
KEY TYPE DESCRIPTIONS
Name String Retention policy name.
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
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.

www.ahsay.com AhsayCBS API Guide | 121 of 450

Day Integer Refers to the “Day” within each Month when setting
the policy’s Type to either Monthly, Quarterly,
Yearly, or Custom.
Week Integer
Month Integer When Type is Quarterly, Month 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, e.g. January,
April, July, and October.
2 – All second months of a quarter, e.g.
February, May, August, and November.
3 – All third months of a quarterMarch, June,
September, December.
When Type is Yearly, Month refers to the specific
month in a year.
Year Integer Refers to the specified Year when setting the
Retention Policy via a Custom Type selection.
DateType String It can be empty for daily or weekly retention policy,
or one of the following:
WEEK_OF_MONTH
WEEK_OF_YEAR
EXACT
Sun, Mon, Tue, Wed, Thu, Fri, Boolean For weekly custom retention policy
Sat

SHADOWPROTECTSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

SHADOWPROTECTSETTING
KEY TYPE DESCRIPTIONS
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 algorithms that may be

presented:

www.ahsay.com AhsayCBS API Guide | 122 of 450

 0 – No encryption
2 – AES 128-bit (A balance between speed and
security)
3 – RC4 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 See AppliedValueSettings.

ADVANCEDSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

ADVANCEDSETTING
KEY TYPE DESCRIPTIONS
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 DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

COMMANDSETTING
KEY TYPE DESCRIPTIONS
Id String ID of the setting.
PreCommandList Array List of Pre-Backup Commands.
PostCommandList Array List of Post-Backup Commands.
AppliedValueSettings Array See AppliedValueSettings.

www.ahsay.com AhsayCBS API Guide | 123 of 450

COMMAND
KEY TYPE DESCRIPTIONS
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)
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 DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

ORACLESETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

ORACLESETTING
KEY TYPE DESCRIPTIONS
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 the Oracle server. Default is 1521.
LoginID String ID used to login. Default is system login.
Password String Password used with LoginID to login.
Sid String Oracle SID.
Version String AhsayCBS version where the Oracle setting was
made.
AppliedValueSettings Array See AppliedValueSettings.

www.ahsay.com AhsayCBS API Guide | 124 of 450

LOTUSNOTESSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings.

LOTUSNOTESSETTING
KEY TYPE DESCRIPTIONS
Id String ID of setting
NotesIniPath String Path notes
Version String AhsayCBS version when the setting was made
AppliedValueSettings Array See AppliedValueSettings

REMINDERSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings

REMINDERSETTING
KEY TYPE DESCRIPTIONS
OfflineNotificationDay Long This setting only applicable for v6 legacy backup
users.
BackupIntervalHour Long 00-23
OfflineBackupEnabled Boolean On-Off
OfflineBackupReminderComputerName String The computer name for the offline backup
reminder.
BackupIntervalDays Long 00-31
ShowOfflineBackupReminder Boolean
LogoutBackupReminderEnabled Boolean On-Off
LogoutBackupReminderComputerName String The computer name for logout backup
reminder.
Id String ID of setting
AppliedValueSettings Array See AppliedValueSettings

www.ahsay.com AhsayCBS API Guide | 125 of 450

FILTERSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings

FILTERSETTING
KEY TYPE DESCRIPTIONS
Enable Boolean True / False
Id String ID of setting
FilterList Array See Filter
AppliedValueSettings Array See AppliedvalueSetting

FILTER
KEY TYPE DESCRIPTIONS
Name String Name of Filter
PatternList Array Displays pattern of Filter
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
CUSTOM
MatchPatternAgainstFulPathOnly Boolean Matches pattern to full path
Include Boolean For each of the matched files/folders under top
directory; exclude or include them
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 DESCRIPTIONS
Pattern String Pattern used for filter

www.ahsay.com AhsayCBS API Guide | 126 of 450

MSWINDOWSSYSTEMSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings

MSWINDOWSSYSTEMSETTING
KEY TYPE DESCRIPTIONS
Id String ID of setting
Version String Version of AhsayCBS when setting was made
BackupTarget String Temporary storage location of the MS Windows
System
AppliedValueSettings Array See Applied Value Setting

LOTUSDOMINOSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings

LOTUSDOMINOSETTING
KEY TYPE DESCRIPTIONS
Id String ID of setting
Version String Version of AhsayCBS when setting was made
NotesIniPath String Path to notes.ini
AppliedValueSettings Array See AppliedValueSetting

TIBEROSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings

TIBEROSETTING

KEY TYPE DESCRIPTIONS

Id String ID of setting
Host String Hostname or IP of the Tibero Databse Server

www.ahsay.com AhsayCBS API Guide | 127 of 450

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 AhsayCBS Version when setting was made
AppliedValueSetting Array See AppliedValueSetting

SCHEDULESETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array List of array settings

SCHEDULESETTING
KEY TYPE DESCRIPTIONS
Id String ID of setting
Enable Boolean True / False
ComputerName String Name of 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 AppliedValueSetting

DAILYSCHEDULELIST

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of setting
Id Long ID of setting
Hour Integer Referred to as HH. It is the schedule wherein the
backup will start (HH:MM)
Minute Integer Referred to as MM. It is the schedule wherein 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

www.ahsay.com AhsayCBS API Guide | 128 of 450

 stop backup after xx hours = 1 to 24
BackupType String The value can be empty, or one of the following:
DATABASE
DIFFERENTIAL
LOG
SKIP
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, 720
(-1 means periodic schedule is disabled that it is a
normal schedule)

WEEKLYSCHEDULELIST

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of setting
Id Long ID of setting
Hour Integer Referred to as HH. Denotes the starting hour of
backup (HH:MM)
Minute Integer Referred to as MM. Denotes the starting minute of
backup (HH:MM)

www.ahsay.com AhsayCBS API Guide | 129 of 450

Duration Integer (optional) If no value is specified, default value = -1
The value can be one of the following:
until full backup completed = -1
stop backup after xx hours = 1 to 24
BackupType String Refer to “BackupType” of DailySchedule.
Days Array The array contains 7 boolean values that
corresponds to Sunday to Saturday. If the boolean
value is true, the backup will be 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, 720
(-1 means periodic schedule is disabled that it is a
normal schedule)

MONTHLYSCHEDULELIST

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of setting
Id Long ID of setting
Hour Integer Referred to as HH. Denotes the starting hour of
backup (HH:MM)
Minute Integer Referred to as MM. Denotes the starting minute of
backup (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
stop backup after xx hours = 1 to 24
Occurrence String The value can be one of the following:
First
Second

www.ahsay.com AhsayCBS API Guide | 130 of 450

 Third
Fourth
Last
Criteria String The value can be one of the following:
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Weekday
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 DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of setting
Id Long ID of setting
Hour Integer Referred to as HH. Denotes the starting hour of
backup (HH:MM)
Minute Integer Referred to as MM. Denotes the starting minute of
backup (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
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

www.ahsay.com AhsayCBS API Guide | 131 of 450

ENCRYPTIONSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array List of Array settings

ENCRYPTIONSETTING
KEY TYPE DESCRIPTIONS
KeyLength Long Length of encryption key
Key String Encryption key
Type String DEFAULT, USER PASSWORD or CUSTOM
Algorithm String Type of encryption used (Twofish, DESede, AES)
Mode String ECB or CBC
Id String ID of setting
AppliedValueSettings Array See AppliedValueSetting

ARCHIVEDLOGDELETIONSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings

ARCHIVEDLOGDELETIONSETTING
KEY TYPE DESCRIPTIONS
Id String ID of setting
Enable Boolean True / False
Days Long Number of days
AppliedValueSettings Array See AppliedValueSetting

CDPSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array Array list of settings

CDPSETTING
KEY TYPE DESCRIPTIONS
Enable Boolean True / False

www.ahsay.com AhsayCBS API Guide | 132 of 450

Id String ID of setting
Type String For version 6, the value can be one of the
following:
all-volume
backup-source
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
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 CDP settings applies to
ComputerName String Name of 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
8
SelectedSourceList Array Array of selected sources
AppliedValueSettings AppliedValueSettings See AppliedValueSetting

CDPBACKUPCONTROL
KEY TYPE DESCRIPTIONS
ConsiderCpuUsage Boolean This setting only applicable for v6 legacy backup
users.

www.ahsay.com AhsayCBS API Guide | 133 of 450

 CpuUsage Integer This setting only applicable for v6 legacy backup
users.
ConsiderInput Boolean This setting only applicable for v6 legacy backup
users.
ObserveInputForSecond Integer This setting only applicable for v6 legacy backup
users.
ConsiderNetworkTraffic Boolean This setting only applicable for v6 legacy backup
users.
NetworkTraffic Long This setting only applicable for v6 legacy backup
users.

RECYCLEBINSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
List Array List of Array settings

RECYCLEBINSETTINGS
KEY TYPE DESCRIPTIONS
AppliedValueSettings Object See AppliedValueSetting
Enabled 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 recycle bin.

USERSETTINGS

KEY TYPE DESCRIPTIONS

MaximumBackupSetsSettings Array Array setting of maximum amount of backup sets
HostLimitSettings Array Arrya list of maximum number of hosts
RunDirectLimitSettings Array Array list of maximum number of VMs
AdvertisementSettings Array Arrya list of advertisement settings
BackupDestinationSettings Array Note: 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

www.ahsay.com AhsayCBS API Guide | 134 of 450

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 o quota settings
CloudBackupSourceSettings Array Cloud Backup sources settings
PasswordSettings Array Password settings
SharedQuotaSettings Array Array list of shared Quota settings

MAXIMUMBACKUPSETSSETTINGS

KEY TYPE DESCRIPTIONS

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

HOSTLIMITSETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
MaxHost Long Number of maximum hosts per user

RUNDIRECTLIMITSETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
MaxVm Long Maximum number of VMs per user

ADVERTISEMENTSETTINGS

KEY TYPE DESCRIPTIONS

AdvertisementList Array Array list of advertising options / settings
Enable Boolean True / False

www.ahsay.com AhsayCBS API Guide | 135 of 450

BACKUPDESTINATIONSETTINGS

KEY TYPE DESCRIPTIONS

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 DESCRIPTIONS
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
Application String For Dropbox only.
Secret
ClientID String For Google Drive destination, OneDrive, OneDrive for Business (Global and
Germany region) only.
ChinaClient For OneDrive for Business (China region) only.
ID
ClientSecret String For Google Drive destination, OneDrive only.
RedirectURI String For OneDrive, OneDrive for Business (Global and Germany region) only.
ChinaRedir String For OneDrive for Business (China region) only.
ectURI

www.ahsay.com AhsayCBS API Guide | 136 of 450

LOGONSETTINGS

KEY TYPE DESCRIPTIONS

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
FOREVER

ENCRYPTIONKEYSETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
Upload Boolean True / False

EMAILREPORTSETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
ConsolidatedReportSendMin Long Time (minute) consolidated e-mail report was sent.
ConsolidatedReportSendHour Long Time (hour) consolidated e-mail report was sent
SendIndividualReport Boolean True / False
Sends individual e-mail reports to users
SendConsolidatedReport Boolean True / False
Sends consolidated e-mail report to users
ContactList Array Array list of contacts

www.ahsay.com AhsayCBS API Guide | 137 of 450

USERQUOTASETTINGS

KEY TYPE DESCRIPTIONS

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 DESCRIPTIONS
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 DESCRIPTIONS

Enable Boolean True / False
Compress Boolean True / False

CLOUDBACKUPSOURCESETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean true / false
CloudSourceList Array Array list of Cloud sources

CLOUDSOURCELIST (CLOUDBACKUPSOURCESETTINGS)
KEY TYPE DESCRIPTIONS
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

www.ahsay.com AhsayCBS API Guide | 138 of 450

 com.ahasy.obx.csp.cpf.policy.userSettings.GoogleCloudStorageSo
urce
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.AWSCompatibleDestina
tion
com.ahsay.obx.cxp.cpf.policy.userSettings.GoogleCloudStorageDe
stination
com.ahsay.obx.cxp.cpf.policy.userSettings.GoogleDriveDestination
com.ahsay.obx.cxp.cpf.policy.userSettings.PooledDestination
com.ahsay.obx.cxp.cpf.policy.userSettings.WindowsAzureDestinati
on
com.ahsay.obx.cxp.cpf.policy.userSettings.OneDriveDestination
com.ahsay.obx.cxp.cpf.policy.userSettings.OneDrive4BizDestinatio
n
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 For OneDrive for Business (China region) only.
ClientSecret String For Google Drive destination, OneDrive only.
RedirectURI String For OneDrive, OneDrive for Business (Global and Germany region)
only.
ChinaRedirectURI String For OneDrive for Business (China region) only.

www.ahsay.com AhsayCBS API Guide | 139 of 450

BusinessApplicati String Application Key of Dropbox for Business; for Dropbox only.
onKey
BusinessApplicati String Application Secret of Dropbox for Business; for Dropbox only.
onSecret

PASSWORDSETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
Type String The value can be one of the following:

DEFAULT
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 DESCRIPTIONS

Enable Boolean True / False
QuotaList Array Array list of Quota settings

QUOTALIST (SHAREDQUOTASETTINGS)
KEY TYPE DESCRIPTIONS
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.

www.ahsay.com AhsayCBS API Guide | 140 of 450

GUISETTINGS

KEY TYPE DESCRIPTIONS

PrivilegeList Array Array list of settings

PRIVILEGE
KEY TYPE DESCRIPTIONS
Id String ID of setting
EnableRead Boolean True / False
EnableWrite Boolean If write privilege is not available for the privilege, this
key is removed from the result.
PrivilegeGroup String
PolicyName String Name of Policy
DisplayName String The name of privilege defined in properties.

PREEMPTEDBACKUPSETSETTINGS

KEY TYPE DESCRIPTIONS

PreemptedBackupSetList Array Refer to BackupSet JSON Object in ListBackupSets
API.

BACKUPSETSETTINGS

KEY TYPE DESCRIPTIONS

ExcludeFileSettings Array Array list of settings

EXCLUDEFILESETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
LastModifiedPeriodType String The value can be one of the following:

YEAR
LastModifiedType String The value can be one of the following:

PERIOD
LastModifiedDate Long Date where setting was last modified

www.ahsay.com AhsayCBS API Guide | 141 of 450

ExcludeFileSize Boolean True / False
ExcludeMappedDrive Boolean True / False
ExcludeLastModified Boolean True / False
FileSize Long True / False
LastModifiedPeriod Long True / False

BACKUPSETTYPESETTINGS

KEY TYPE DESCRIPTIONS

BackupSetTypeList Array Newly added to v8.5
[{
“@class”:”com.ahsay.obx.cxp.cpf.policy.backupSet
Settings.MariaDBType”
“Name”:”MariaDB”
}]
Enable Boolean true / false

DEFAULTVALUES

KEY TYPE DESCRIPTIONS

VmwareSettingsList Array Array list; VMware settings
VolumeShadowCopySettingsList Array Array list: Volume Shadow Copoy 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: Open Direct 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 Permission settings

www.ahsay.com AhsayCBS API Guide | 142 of 450

 RetentionPolicySettingsList Array Array list: Retention Policy settings
ShadowProtectSettingsList Array Array list: Shadow Protect 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” MS Windows System settings
LotusDominoSettingsList Array Array list: Lotus Domino settings
TiberoSettingsList Array Array for 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” CDP settings
SourceShortcutSettingsList Array Array list: Source Shortcut settings
MariaDBSettingsList Array Array list” MariaDB settings
RecycleBinSettingsList Array Array list” Recycle Bin settings
DeduplicationSettingsList Object Refer to DeduplicationSettingsList, list of
Deduplication Settings.

DEDUPLICATIONSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean Enable or disable the list of Deduplication Settings.
List Array Array of DeduplicationSettings (Policy).

ARRAY – DEDUPLICATION SETTINGS (POLICY)

KEY TYPE DESCRIPTIONS
Enabled Boolean Whether Deduplication is enabled.
@class String com.ahsay.obx.cxp.cpf.policy.values.deduplication.Dedup
licationSettings
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

www.ahsay.com AhsayCBS API Guide | 143 of 450

 524288 for 512k-2M
1048576 for 1M-4M
Note: 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 settings to which
module(s).

LOGINWEBCONSOLESETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean True = Policy applies.
AllowWebConsoleLogin Boolean True = Allow Backup User to login into CBS Web
Console.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is “Error”
ExptType String The type of exception, it exists only if status is “Error”

www.ahsay.com AhsayCBS API Guide | 144 of 450

EXAMPLES

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”:””,

www.ahsay.com AhsayCBS API Guide | 145 of 450

 “Mode”:””,
“BackupMode”:””,
“AppliedMoeduleSettingsList”:[
{
“Enable”:false,
“Name”:”FILE”
},
{
“Enable”:false,
“Name”:”Lotus Domino”
},
{
“Enable”:false,
“Lotus 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,
“Microsoft Windows System Backup”
},
{
“Enable”:false,
“Name”:”MySQL”
},
{
“Enable”:false,
“Name”:”MariaDB”
},
{
“Enable”:false,

www.ahsay.com AhsayCBS API Guide | 146 of 450

 “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”:”abc123”,
“LoginName”:”username”,
“ID”:”1692164125127”
}
OUTPUT 1

www.ahsay.com AhsayCBS API Guide | 147 of 450

{

“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”:”Lotus 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 Virtuaization”

www.ahsay.com AhsayCBS API Guide | 148 of 450

 },
{
“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
}

www.ahsay.com AhsayCBS API Guide | 149 of 450

LISTUSERGROUPS
This API can be used to retrieve the information of a User Group.

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

Backup / Restore > Users, Groups & Policies > User Group

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListUserGroups.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
UserGroupID String Returns information of the user group with this ID. If
UserGroupID and UserID are not provided, information
of all user groups will be returned.
UserID String Returns information of the user groups that contain the
user. If UserGroupID and UserID are not provided,
information of all user groups will be returned.
UserGroupOnly Boolean Default value is false.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data UserGroupBasicInfo If UserGroupOnly is true, UserGroupBasicInfo is
or returned. Otherwise, UserGroupFillInfo is returned.
UserGroupFullInfo
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 150 of 450

JSON OBJECTS

USERGROUPBASICINFO

KEY TYPE DESCRIPTIONS

ID String ID of User Group
Name String Name of User Group
Type String BACKUP_USER
Owner String Owner of User Group

USERGROUPFULLINFO

KEY TYPE DESCRIPTIONS

ID String ID of User Group
Name String Name of User Group
Type String BACKUP_USER
Owner String Owner of User Group
Users Array of User Array list of Users assigned to User Group
PolicyGroup Array of Policy Array list of assigned Policy Group to User Group

USER

KEY TYPE DESCRIPTIONS

LoginName String Client user name.
Owner String Owner of User
UserId String ID of User

POLICY

KEY TYPE DESCRIPTIONS

ID String ID of Policy
Name String Name of Policy

www.ahsay.com AhsayCBS API Guide | 151 of 450

EXAMPLE

INPUT
{
“SysUser”:”api”,
“SysPwd”:”pwd”,
“UserGroupOnly”:true
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“Type”:”BACKUP_USER”,
“Owner”:””,
“ID”:”1”,
“Name”:”All Users”,
}
]
}

www.ahsay.com AhsayCBS API Guide | 152 of 450

MODIFYUSERGROUP
This API lets you modify the name of a User Group, add users or delete user to / from a User
Group.

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

Backup / Restore > Users, Groups & Policies > User Group

URL
https://CBS.EXAMPLE.COM/obs/api/json/ModifyUserGroup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
ID String User Group ID obtainable in from ListUserGroups API.
UserGroupName String Group name.
UserIdList String User names to be added to or removed from the user
group. Multiple login names, separated by commas, are
accepted. For example: user1, user2, user3.
Mode String The value can be any one of the following:
A (Default value)
D
If the value is “A”, users in UserIdList will be added to
the user group.
If the value is “D”, users in the UserIdList will be
removed from the user group.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 153 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”api”,
“SysPwd”:”pwd”,
“ID”:”1447039919940”,
“UserIdList”:”user”,
“Mode”:”D”
}
OUTPUT 1
{
“Status”:”OK”,
}
OUTPUT 2 – User does not exist
{
“Status”:”Error”,
“Message”:”[UserCacheManager.NoSuchUserExpt] User ‘user’ not found.”,
“ExptType”:”com.ahsay.obs.core.dbs.Y”
}

EXAMPLE 2

INPUT – Incorrect parameter mode

{
“SysUser”:”api”,
“SysPwd”:”pwd”,
“ID”:”1447039919940”,
“UserIdList”:”user”,
“Mode”:”S”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter Mode must either be A or D!”,
“ExptType”:”com.ahsay.obs.core.dbs.c”
}

www.ahsay.com AhsayCBS API Guide | 154 of 450

UPDATEPOLICYGROUP (V1, V2)
This API can be used to update settings of a Policy Group.

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

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

The Policy Group ID can be created using AddPolicyGroup.do or can be found from the
AhsayCBS Policy Group page, by looking at the URL. Example:
https://CBS.EXAMPLE.COM/cbs/obs/policy/EditPolicy.do?id=1632367172249

NOTE
Retrieve all available parameters of policies that you can update by calling the ListPolicyGroups.do API first.

V1 UPDATEPOLICYGROUP.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdatePolicyGroup.do
DEPRECATED SINCE VERSION
7.15.6.38

V2 UPDATEPOLICYGROUP.DO

For features related to Quota Management, administrator needs to utilize v2

UpdatePolicyGroup.do

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/UpdatePolicyGroup.do
AVAILABLE SINCE VERSION:
9.5
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
ID String Policy Group ID
Name String Policy name (rename possible).
Owner String Input SubAdmin name if Policy to be assigned to a
SubAdmin

www.ahsay.com AhsayCBS API Guide | 155 of 450

 NOTE
For details of all available parameters, please refer to the PolicyGroup JSON object outlined in the
ListPolicyGroups chapter.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

JSON OBJECTS

PREEMPTEDVALUES

KEY TYPE DESCRIPTIONS

TiberoSettingsList Array Array for Tibero settings.

APPLIEDVALUESETTING

KEY TYPE DESCRIPTIONS

AppliedModuleSettingsList 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

www.ahsay.com AhsayCBS API Guide | 156 of 450

 Office 365 Exchange Online
Tibero Database Server
If a String above is added to the array, that module is
selected

CLOUDSOURCELIST

KEY TYPE DESCRIPTIONS

@class String The value can be one of the following:
com.ahsay.obx.cxp.cpf.policy.userSettings.AmazonS3Source
com.ahsay.obx.cxp.cpf.policy.userSettings.AWSCompatibleSource
com.ahsay.obx.cxp.cpf.policy.userSettings.GoogleCloudStorageSour
ce
com.ahsay.obx.cxp.cpf.policy.userSettings.GoogleDriveSource
com.ahsay.obx.cxp.cpf.policy.userSettings.WindowsAzureSource
com.ahsay.obx.cxp.cpf.policy.userSettings.OneDriveSource
com.ahsay.obx.cxp.cpf.policy.userSettings.OneDrive4BizSource
com.ahsay.obx.cxp.cpf.policy.userSettings.RackspaceSource
com.ahsay.obx.cxp.cpf.policy.userSettings.OpenStackSource
com.ahsay.obx.cxp.cpf.policy.userSettings.DropboxSource
com.ahsay.obx.cxp.cpf.policy.userSettings.FtpSource
com.ahsay.obx.cxp.cpf.policy.userSettings.SftpSource
com.ahsay.obx.cxp.cpf.policy.userSettings.AliyunSource
com.ahsay.obx.cxp.cpf.policy.userSettings.BackblazeSource
com.ahsay.obx.cxp.cpf.policy.userSettings.CTYunSource
com.ahsay.obx.cxp.cpf.policy.userSettings.WasabiSource
BusinessApplicatio String Application Key of Dropbox for Business; for Dropbox only.
nKey
BusinessApplicatio String Application Secret of Dropbox for Business, for Dropbox only.
nSecret

TIBEROSETTINGSLIST

KEY TYPE DESCRIPTIONS

Enable Boolean “OK” or “Error”
List Array Array list of settings

TIBEROSETTING

KEY TYPE DESCRIPTIONS

Id String ID of setting
Host String Hostname or IP to Tibero Database Server

www.ahsay.com AhsayCBS API Guide | 157 of 450

Port String Port Number of Tibero Database Server (default is
8629)
LoginID String Login 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 Tibero Database Server version
AppliedValueSettings Array See AppliedValueSetting

DEFAULTVALUES

KEY TYPE DESCRIPTIONS

TiberoSettingsList Array Array for Tibero settings

www.ahsay.com AhsayCBS API Guide | 158 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”api”,
“SysPwd”:”pwd”,
“Name”:”Default settings”,
“ID”:”2”,
“Owner”:””,
“UserSettings”:{
“HostLimitSettings”:{
“Enable”:true,
“MaxHost”:45
}
}
}
OUTPUT
{
“Status”:”OK”,
}

www.ahsay.com AhsayCBS API Guide | 159 of 450

EXAMPLE 2: DEDUPLICATION (SNIPPET)

INPUT
{
“SysUser”:”api”,
“SysPwd”:”pwd”,
“ID”:”2”,
“Owner”:””,
“DefaultValues”:{
“DeduplicationSettingsList”:{
“Enable”:true,
“List”:[
{

“@class”:”com.ahsay.obx.cxp.cpf.policy.values.deduplicatio.DeduplicationSett
ings”,
“MigrateData”:false,
“AppliedValueSettings””:{
“Type”:”default”,

“@class”:”com.ahsay.obx.cxp.cpf.policy.values.AppliedValuesSettings”,
“Os”:””,
“Version”:””,
“Mode”:””,
“BackupMode”:””,
“AppliedModuleSettingsList”:[
{
“Enable”:false,
“Name”:”FILE”
},
{
“Enable”:false,
“Name”:”Lotus Domino”
},
{
“Enable”:false,
“Name”:”Lotus Notes”
},
{
“Enable”:false,
“Name”:”Microsoft Exchange Server”
},
{
“Enable”:false,
“Name”:”Microsoft Exchange Mail (MAPI)”

www.ahsay.com AhsayCBS API Guide | 160 of 450

 },
{
“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
}

www.ahsay.com AhsayCBS API Guide | 161 of 450

 “Id”:”1434946034923”,
“Name”:”Default deduplication settings–Vmware & Hyper-V”
}
]
}
}
}
OUTPUT
{
“Status”:”OK”,
}

EXAMPLE 3

INPUT
{
"SysUser":"system",
"SysPwd":"system1",
"Name": "api-test-policy",
"ID": "1632367172249",
"Owner": "",
"PreemptedValues": {
"VmwareSettingsList": {
"Enable": false,
"List": []
},
"VolumeShadowCopySettingsList": {
"Enable": false,
"List": []
},
"AllowedIPSettingsList": {
"Enable": false,
"List": []
},
"FollowLinkSettingsList": {
"Enable": false,
"List": []
},
"InFileDeltaSettingsList": {
"Enable": false,
"List": []
},

www.ahsay.com AhsayCBS API Guide | 162 of 450

 "CompressionsSettingsList": {
"Enable": false,
"List": []
},
"WinUserAuthSettingsList": {
"Enable": false,
"List": []
},
"FileSettingsList": {
"Enable": false,
"List": []
},
"MswindowsSystemStateSettingsList": {
"Enable": false,
"List": []
},
"DestinationSettingsList": {
"Enable": false,
"List": []
},
"BandwidthControlSettingsList": {
"Enable": false,
"List": []
},
"NameSettingsList": {
"Enable": false,
"List": []
},
"RetentionPolicySettingsList": {
"Enable": false,
"List": []
},
"FilePermissionsSettingsList": {
"Enable": false,
"List": []
},
"MySQLSettingsList": {
"Enable": false,
"List": []
},
"ShadowProtectSettingsList": {
"Enable": false,
"List": []
},
"AdvancedSettingsList": {

www.ahsay.com AhsayCBS API Guide | 163 of 450

 "Enable": false,
"List": []
},
"CommandSettingsList": {
"Enable": false,
"List": []
},
"TemporaryDirectorySettingsList": {
"Enable": false,
"List": []
},
"OracleSettingsList": {
"Enable": false,
"List": []
},
"ReminderSettingsList": {
"Enable": false,
"List": []
},
"LotusNotesSettingsList": {
"Enable": false,
"List": []
},
"FilterSettingsList": {
"Enable": false,
"List": []
},
"MswindowsSystemSettingsList": {
"Enable": false,
"List": []
},
"LotusDominoSettingsList": {
"Enable": false,
"List": []
},
"ScheduleSettingsList": {
"Enable": false,
"List": []
},
"ArchivedLogDeletionSettingsList": {
"Enable": false,
"List": []
},
"EncryptionSettingsList": {
"Enable": false,

www.ahsay.com AhsayCBS API Guide | 164 of 450

 "List": []
},
"CdpSettingsList": {
"Enable": false,
"List": []
}
},
"UserSettings": {
"MaximumBackupSetsSettings": {
"MaximumBackupSetsPerUser": 10,
"Enable": false
},
"BackupDestinationSettings": {
"ApplicationName": "",
"CustomDestinationList": [
{
"ChinaClientID": "e71a1234-1234-1234-b2f4-ccf1aa830a78",
"@class":
"com.ahsay.obx.cxp.cpf.policy.userSettings.OneDrive4BizDestination",
"ChinaRedirectURI": "https://backupserserver/register/oauth2-
office365.jsp",
"Enable": true,
"ClientID": "d349b19f-0a90-1234-1234-0caa8224da04",
"RedirectURI": "https://backupserserver/register/oauth2-
office365.jsp",
"Name": "OneDrive4Biz"
}
],
"SystemDestIDList": [],
"Enable": false,
"SystemDestinationList": []
},
"QuotaSettings": {
"SharedQuota": 10737418240,
"MaxPercentage": 50,
"Enable": true,
"Compress": true,
"SharedQuotaEnable": false
},
"CloudBackupSourceSettings": {
"Enable": true,
"CloudSourceList": [
{
"ChinaClientID": "e71a1234-1234-1234-b2f4-ccf1aa830a78",
"@class":

www.ahsay.com AhsayCBS API Guide | 165 of 450

"com.ahsay.obx.cxp.cpf.policy.userSettings.OneDrive4BizSource",
"ChinaRedirectURI": "https://backupserver/register/oauth2-
office365.jsp",
"ClientID": "d349b19f-0a90-1234-1234-0caa8224da04",
"RedirectURI": "https://backupserver/register/oauth2-
office365.jsp",
"Name": "OneDrive4Biz"
}
]
},
"EncryptionKeySettings": {
"Enable": false,
"Upload": false
},
"EmailReportSettings": {
"ContactList": [],
"SendInactiveBSetReport": false,
"Enable": false,
"ConsolidatedReportSendMin": 0,
"SendIndividualReport": false,
"SendConsolidatedReport": false,
"InactiveBSetReportSendDay": 30,
"ConsolidatedReportSendHour": 0
},
"PasswordSettings": {
"EnforcePasswordHistory": true,
"MinimumLength": 6,
"SpecialCharacters": true,
"Uppercase": true,
"Enable": false,
"Lowercase": true,
"Number": true,
"Type": "DEFAULT",
"PasswordAge": 90,
"MinimumLengthEnabled": true,
"Regex": ""
},
"LogonSettings": {
"InvalidLoginAttemptPeriod": 30,
"Enable": false,
"NumOfInvalidLogin": 3,
"BlockMinute": 60,
"BlockType": "MINUTE",
"BlockHour": 24
}

www.ahsay.com AhsayCBS API Guide | 166 of 450

 },
"Type": "BACKUP_USER",
"PreemptedBackupSetSettings": {
"PreemptedBackupSetList": []
},
"GuiSettings": {
"PrivilegeList": [
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Backup",
"EnableRead": true,
"Id": "M-10001",
"DisplayName": "Backup"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Restore",
"EnableRead": true,
"Id": "M-10002",
"DisplayName": "Restore"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "BackupSets",
"EnableRead": true,
"Id": "M-10003",
"DisplayName": "Backup Sets"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Settings",
"EnableRead": true,
"Id": "M-10004",
"DisplayName": "Settings"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Report",
"EnableRead": true,
"Id": "M-10005",
"DisplayName": "Report"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Utilities",

www.ahsay.com AhsayCBS API Guide | 167 of 450

 "EnableRead": true,
"Id": "M-10006",
"DisplayName": "Utilities"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Profile",
"EnableRead": true,
"Id": "M-10007",
"DisplayName": "Profile"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Language",
"EnableRead": true,
"Id": "M-10008",
"DisplayName": "Language",
"EnableWrite": true
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Information",
"EnableRead": true,
"Id": "M-10009",
"DisplayName": "Information"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "Advertisement",
"EnableRead": true,
"Id": "M-10010",
"DisplayName": "Advertisement"
},
{
"PrivilegeGroup": "MainMenu",
"PolicyName": "SocialMedia",
"EnableRead": true,
"Id": "M-10011",
"DisplayName": "Links to Social Media"
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "ProfileGeneralTab",
"EnableRead": true,
"Id": "P-10001",

www.ahsay.com AhsayCBS API Guide | 168 of 450

 "DisplayName": "General Tab"
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "ProfileGeneralSettings",
"EnableRead": true,
"Id": "P-10002",
"DisplayName": "General Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "ContactsTab",
"EnableRead": true,
"Id": "P-10003",
"DisplayName": "Contacts Tab"
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "ContactsSettings",
"EnableRead": true,
"Id": "P-10004",
"DisplayName": "Contacts Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "TimezoneTab",
"EnableRead": true,
"Id": "P-10005",
"DisplayName": "Timezone Tab"
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "TimezoneSettings",
"EnableRead": true,
"Id": "P-10006",
"DisplayName": "Timezone Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "PasswordTab",
"EnableRead": true,
"Id": "P-10007",

www.ahsay.com AhsayCBS API Guide | 169 of 450

 "DisplayName": "Password Tab"
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "PasswordSettings",
"EnableRead": true,
"Id": "P-10008",
"DisplayName": "Password Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "EncryptionRecoveryTab",
"EnableRead": true,
"Id": "P-10009",
"DisplayName": "Encryption Recovery Tab"
},
{
"PrivilegeGroup": "Profile",
"PolicyName": "EncryptionRecoverySettings",
"EnableRead": true,
"Id": "P-100010",
"DisplayName": "Encryption Recovery Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsName",
"EnableRead": true,
"Id": "BS-10003",
"DisplayName": "General Settings - Name",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsIBMDomino",
"EnableRead": true,
"Id": "BS-10004",
"DisplayName": "General Settings - IBM Domino",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsIBMNotes",
"EnableRead": true,

www.ahsay.com AhsayCBS API Guide | 170 of 450

 "Id": "BS-10005",
"DisplayName": "General Settings - IBM Notes",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsMSExchangeServer",
"EnableRead": true,
"Id": "BS-10006",
"DisplayName": "General Settings - MS Exchange Server",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsMSHyperV",
"EnableRead": true,
"Id": "BS-10007",
"DisplayName": "General Settings - MS HyperV",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsMSSQLServer",
"EnableRead": true,
"Id": "BS-10008",
"DisplayName": "General Settings - MSSQL Server",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsWindowsSystemBackup",
"EnableRead": true,
"Id": "BS-10009",
"DisplayName": "General Settings - Windows System Backup",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsWindowsSystemStateBackup",
"EnableRead": true,
"Id": "BS-10010",
"DisplayName": "General Settings - Windows System State
Backup",
"EnableWrite": true
},

www.ahsay.com AhsayCBS API Guide | 171 of 450

 {
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsMySQLServer",
"EnableRead": true,
"Id": "BS-10011",
"DisplayName": "General Settings - MySQL Server",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsOracleDatabaseServer",
"EnableRead": true,
"Id": "BS-10012",
"DisplayName": "General Settings - Oracle Database Server",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsVMwareHost",
"EnableRead": true,
"Id": "BS-10013",
"DisplayName": "General Settings - VMware Host",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsShadowProtect",
"EnableRead": true,
"Id": "BS-10014",
"DisplayName": "General Settings - Shadow Protect",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralSettingsWindowsUserAuthentication",
"EnableRead": true,
"Id": "BS-10015",
"DisplayName": "General Settings - Windows User Authentication",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "SourceTab",
"EnableRead": true,
"Id": "BS-10016",

www.ahsay.com AhsayCBS API Guide | 172 of 450

 "DisplayName": "Source Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "SourceSettingsBackupSource",
"EnableRead": true,
"Id": "BS-10017",
"DisplayName": "Source Settings - BackupSource",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "SourceSettingsFilter",
"EnableRead": true,
"Id": "BS-10018",
"DisplayName": "Source Settings - Filter",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "BackupScheduleTab",
"EnableRead": true,
"Id": "BS-10020",
"DisplayName": "Backup Schedule Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "BackupScheduleSettings",
"EnableRead": true,
"Id": "BS-10021",
"DisplayName": "Backup Schedule Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "ContinuousBackupTab",
"EnableRead": true,
"Id": "BS-10022",
"DisplayName": "Continuous Backup Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "ContinuousBackupSettings",
"EnableRead": true,
"Id": "BS-10023",

www.ahsay.com AhsayCBS API Guide | 173 of 450

 "DisplayName": "Continuous Backup Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "DestinationTab",
"EnableRead": true,
"Id": "BS-10024",
"DisplayName": "Destination Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "DestinationSettings",
"EnableRead": true,
"Id": "BS-10025",
"DisplayName": "Destination Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "InFileDeltaTab",
"EnableRead": true,
"Id": "BS-10026",
"DisplayName": "In-File Delta Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "InFileDeltaSettings",
"EnableRead": true,
"Id": "BS-10027",
"DisplayName": "In-File Delta Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "RetentionPolicyTab",
"EnableRead": true,
"Id": "BS-10028",
"DisplayName": "Retention Policy Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "RetentionPolicySettings",
"EnableRead": true,
"Id": "BS-10029",

www.ahsay.com AhsayCBS API Guide | 174 of 450

 "DisplayName": "Retention Policy Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "CommandLineToolTab",
"EnableRead": true,
"Id": "BS-10030",
"DisplayName": "Command Line Tool Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "CommandLineToolSettings",
"EnableRead": true,
"Id": "BS-10031",
"DisplayName": "Command Line Tool Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "ReminderTab",
"EnableRead": true,
"Id": "BS-10032",
"DisplayName": "Reminder Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "ReminderSettings",
"EnableRead": true,
"Id": "BS-10033",
"DisplayName": "Reminder Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "BandwidthControlTab",
"EnableRead": true,
"Id": "BS-10034",
"DisplayName": "Bandwidth Control Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "BandwidthControlSettings",
"EnableRead": true,
"Id": "BS-10035",

www.ahsay.com AhsayCBS API Guide | 175 of 450

 "DisplayName": "Bandwidth Control Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersTab",
"EnableRead": true,
"Id": "BS-10038",
"DisplayName": "Others Tab"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersSettingsTemporaryDirectory",
"EnableRead": true,
"Id": "BS-10039",
"DisplayName": "Others Settings - Temporary Directory",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersSettingsFollowLink",
"EnableRead": true,
"Id": "BS-10040",
"DisplayName": "Others Settings - Follow Link",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersSettingsVolumeShadowCopy",
"EnableRead": true,
"Id": "BS-10041",
"DisplayName": "Others Settings - Volume Shadow Copy",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersSettingsFilePermissions",
"EnableRead": true,
"Id": "BS-10042",
"DisplayName": "Others Settings - File Permissions",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersSettingsArchivedLogDeletion",

www.ahsay.com AhsayCBS API Guide | 176 of 450

 "EnableRead": true,
"Id": "BS-10043",
"DisplayName": "Others Settings - Archived Log Deletion",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersSettingsCompressions",
"EnableRead": true,
"Id": "BS-10044",
"DisplayName": "Others Settings - Compressions",
"EnableWrite": true
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersSettingsEncryption",
"EnableRead": true,
"Id": "BS-10045",
"DisplayName": "Others Settings - Encryption"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "OthersSettingsChangedBlockTracking",
"EnableRead": true,
"Id": "BS-10046",
"DisplayName": "Others Settings - Changed Block Tracking",
"EnableWrite": true
},
{
"PrivilegeGroup": "Settings",
"PolicyName": "ProxyTab",
"EnableRead": true,
"Id": "S-10001",
"DisplayName": "Proxy Tab"
},
{
"PrivilegeGroup": "Settings",
"PolicyName": "ProxySettings",
"EnableRead": true,
"Id": "S-10002",
"DisplayName": "Proxy Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "Settings",

www.ahsay.com AhsayCBS API Guide | 177 of 450

 "PolicyName": "WindowsEventLogTab",
"EnableRead": true,
"Id": "S-10005",
"DisplayName": "Windows Event Log Tab"
},
{
"PrivilegeGroup": "Settings",
"PolicyName": "WindowsEventLogSettings",
"EnableRead": true,
"Id": "S-10006",
"DisplayName": "Windows Event Log Settings",
"EnableWrite": true
},
{
"PrivilegeGroup": "Utilities",
"PolicyName": "DataIntegrityCheck",
"EnableRead": true,
"Id": "U-10001",
"DisplayName": "Data Integrity Check"
},
{
"PrivilegeGroup": "Utilities",
"PolicyName": "SpaceFreeingUp",
"EnableRead": true,
"Id": "U-10002",
"DisplayName": "Space Freeing Up"
},
{
"PrivilegeGroup": "Utilities",
"PolicyName": "DeleteBackupData",
"EnableRead": true,
"Id": "U-10003",
"DisplayName": "Delete Backup Data"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "AddAndRemove",
"EnableRead": true,
"Id": "BS-10001",
"DisplayName": "Add and Remove Backup Set"
},
{
"PrivilegeGroup": "BackupSets",
"PolicyName": "GeneralTab",
"EnableRead": true,

www.ahsay.com AhsayCBS API Guide | 178 of 450

 "Id": "BS-10002",
"DisplayName": "General Tab"
}
]
},
"ID": "1446023471399",
"BackupSetSettings": {
"ExcludeFileSettings": {
"LastModifiedPeriod": 10,
"FileSize": 10737418240,
"ExcludeMappedDrive": true,
"ExcludeLastModified": true,
"LastModifiedPeriodType": "YEAR",
"LastModifiedType": "PERIOD",
"Enable": false,
"LastModifiedDate": -1,
"ExcludeFileSize": true
}
},
"DefaultValues": {
"VmwareSettingsList": {
"Enable": false,
"List": []
},
"VolumeShadowCopySettingsList": {
"Enable": false,
"List": []
},
"AllowedIPSettingsList": {
"Enable": false,
"List": []
},
"FollowLinkSettingsList": {
"Enable": false,
"List": []
},
"InFileDeltaSettingsList": {
"Enable": false,
"List": []
},
"CompressionsSettingsList": {
"Enable": false,
"List": []
},
"WinUserAuthSettingsList": {

www.ahsay.com AhsayCBS API Guide | 179 of 450

 "Enable": false,
"List": []
},
"FileSettingsList": {
"Enable": false,
"List": []
},
"MswindowsSystemStateSettingsList": {
"Enable": false,
"List": []
},
"DestinationSettingsList": {
"Enable": false,
"List": []
},
"BandwidthControlSettingsList": {
"Enable": false,
"List": []
},
"NameSettingsList": {
"Enable": false,
"List": []
},
"RetentionPolicySettingsList": {
"Enable": false,
"List": []
},
"FilePermissionsSettingsList": {
"Enable": false,
"List": []
},
"MySQLSettingsList": {
"Enable": false,
"List": []
},
"ShadowProtectSettingsList": {
"Enable": false,
"List": []
},
"AdvancedSettingsList": {
"Enable": false,
"List": []
},
"CommandSettingsList": {
"Enable": false,

www.ahsay.com AhsayCBS API Guide | 180 of 450

 "List": []
},
"TemporaryDirectorySettingsList": {
"Enable": false,
"List": []
},
"OracleSettingsList": {
"Enable": false,
"List": []
},
"ReminderSettingsList": {
"Enable": false,
"List": []
},
"LotusNotesSettingsList": {
"Enable": false,
"List": []
},
"FilterSettingsList": {
"Enable": false,
"List": []
},
"MswindowsSystemSettingsList": {
"Enable": false,
"List": []
},
"LotusDominoSettingsList": {
"Enable": false,
"List": []
},
"ScheduleSettingsList": {
"Enable": false,
"List": []
},
"ArchivedLogDeletionSettingsList": {
"Enable": false,
"List": []
},
"EncryptionSettingsList": {
"Enable": false,
"List": []
},
"CdpSettingsList": {
"Enable": false,
"List": []

www.ahsay.com AhsayCBS API Guide | 181 of 450

 }
}
}
OUTPUT 1: If no errors
{
“Status”:”OK”,
}
OUTPUT 2: If v1 UpdatePolicyGroup parameter FileSettingsList was in the input
{
“Status”:”Error”,
“Message”:”FileSettingsList” is deprecated. It is only supported in
UpdatePolicyGroup v1 API. Please use ‘SourceShortcutSettingsList’ instead”
“ExptType”:”java.lang.Exception”
}
OUTPUT 3: If ClientID is empty from the input
{
“Status”:”Error”,
“Message”:”ClientID cannot be empty in OneDrive4Biz of
CustomDestinationList!”
“ExptType”:”java.lang.Exception”
}
OUTPUT 4: If RedirectURI is empty from the input
{
"Status": "Error",
"Message": "RedirectURI cannot be empty in OneDrive4Biz of
CustomDestinationList!"
"ExptType": "java.lang.Exception"
}
OUTPUT 5: If ChinaClientID is empty from the input
{
"Status": "Error",
"Message": "ChinaClientID cannot be empty in OneDrive4Biz of
CustomDestinationList!"
"ExptType": "java.lang.Exception"
}
OUTPUT 6: If ChinaRedirectURI is empty from the input
{
"Status": "Error",
"Message": "ChinaRedirectURI cannot be empty in OneDrive4Biz of
CustomDestinationList!"
"ExptType": "java.lang.Exception"
}

www.ahsay.com AhsayCBS API Guide | 182 of 450

 NOTE
The same error will also be displayed if the ClientID, RedirectURI, ChinaClientID, or ChinaRedirectURI is
empty in the CloudSourceList.

It is highly recommended for administrators to retrieve all policy settings with the v2 ListPolicyGroups API.
Update the values of the settings to be changed, based on the response parameters returned by the v2
ListPolicyGroups API.

EXAMPLE 4 – Incorrect Value

INPUT
{
"SysUser":"api_user",
"SysPwd":"qWeRtY123456!@#$%",
"ID": "2",
"UserSettings": {
"UserQuotaSettings": {
"QuotaType":"perDestinationQuota",
"StorageQuota" : 0
}
}
}
OUTPUT
{
"Status": "Error",
"Message": "Invalid value. 'QuotaType' must be 'TOTAL_QUOTA' or
'PER_DESTINATION_QUOTA'.",
"ExptType": "com.ahsay.obs.core.dbs.DbsException"
}

EXAMPLE 5 – Incorrect Value

INPUT
{
"SysUser":"api_user",
"SysPwd":"qWeRtY123456!@#$%",
"ID": "2",
"UserSettings": {
"UserQuotaSettings": {
"QuotaType":" TOTAL_QUOTA",
"StorageQuota" : 0
}
}
}

www.ahsay.com AhsayCBS API Guide | 183 of 450

OUTPUT
{
"Status": "Error",
"Message": "Invalid value 'StorageQuota'. Error: Must be a positive
number.",
"ExptType": "java.lang.Exception"
}

www.ahsay.com AhsayCBS API Guide | 184 of 450

ADDPOLICYGROUP
This API lets you add (create) a new Policy Group and optionally allocate it to User Group(s),
returned is the PolicyGroupID that can be used with UpdatePolicyGroup.do.

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

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

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddPolicyGroup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
Name String Name of the Policy Group
Owner String Input SubAdmin name if Policy to be assigned to a
SubAdmin
UserGroupIDList Array of Array of User Group ID
Strings

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.
PolicyGroupID String ID of the Policy Group

www.ahsay.com AhsayCBS API Guide | 185 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Name”:”Default settings”,
“Owner”:””,
“UserGroupIDList”:[”1”]
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter Name, Default settings, already exists!”,
“ExptType”:”com.ahsay.cbs.mT”
}

EXAMPLE 2

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Name”:”UG Test”,
“Owner”:”test”,
“UserGroupIDList”:[“1686621934417”]
}
OUTPUT
{
“Status”:”OK”,
“PolicyGroupID”:”1686622515427”
}

www.ahsay.com AhsayCBS API Guide | 186 of 450

EXAMPLE 3

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Name”:”UG Test”,
“Owner”:”test”,
“UserGroupIDList”:[“1”,”3”]
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter UserGroupID, 3 is not a 13-digit format!”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException
}

EXAMPLE 4

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Name”:”UG Test”,
“Owner”:”test”,
“UserGroupIDList”:[0]
}
OUTPUT
{
“Status”:”OK”,
“Message”:”JSONArray[0] is not a String (class java.lang.Integer : 0).”
“ExptType”:”org.json.JSONException”
}

www.ahsay.com AhsayCBS API Guide | 187 of 450

EXAMPLE 5

INPUT
{
“SysUser”:”api”,
“SysPwd”:”pwd”,
“Name”:”UG Test”,
“Owner”:0,
“UserGroupIDList”:[“1”]
}
OUTPUT
{
“Status”:”OK”,
“Message”:”[Error] Parameter Owner ‘0’ is not a valid owner.”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 188 of 450

ADDPOLICYGROUPTOUSERGROUP
This API lets you assign Policy Group(s) to a User Group.

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

Backup/Restore > Users, Groups & Policies > User Group

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddPolicyGroupToUserGroup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
UserGroupID String ID of User Group
PolicyGroupIDList Array of Array of Policy Group ID
Strings

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if the status is
“Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 189 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“UserGroupID”:”1686621934417”,
“PolicyGroupIDList”:[“1686625081008”]
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“UserGroupID”:”1686621934417”,
“PolicyGroupIDList”:[“1686626692901”,”1686626701490”]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 190 of 450

EXAMPLE 3

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“UserGroupID”:”1686621934417”,
“PolicyGroupIDList”:[“1686626692901”]
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter PolicyGroupIDList, 1686626692901, already
exists in UserGroupID 1686621934417!”,
“ExptType”:”com.ahsay.cbs.mT”
}

EXAMPLE 4

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“UserGroupID”:”2”,
“PolicyGroupIDList”:[“1”]
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter UserGroupID, 2 is not 13-digit format!”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 191 of 450

EXAMPLE 5

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“UserGroupID”:”1111111111111”,
“PolicyGroupIDList”:[“2”]
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter UserGroupID, 1111111111111 does not
exist!”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 192 of 450

3 USER API
3.1 USER

LISTUSERS (V1, V2)

This API can be used to retrieve user’s information, with various filter options. The related
settings can be found on the AhsayCBS web console:

Backup]/Restore > Users, Groups & Policies > Backup User

V1 LISTUSERS.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListUsers.do
DEPRECATED SINCE VERSION
7.15.6.38

V2 LISTUSERS.DO

v2 ListUsers.do API was introduced for handling of features related to Quota Management.

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/ListUsers.do
AVAILABLE SINCE VERSION:
9.7.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
Criteria String all
paid
trial
suspended
locked
inactive
A-B
B-C

www.ahsay.com AhsayCBS API Guide | 193 of 450

 …
and
others
searchBy String “Name”
searchStr String Only users with login name that contains searchStr are
listed.
reseller String Login name of a reseller. Only users under that reseller
are listed.
UserGroupID String ID of a user group. Only users under that user group are
listed.
PolicyGroupID String ID of a policy group. Only users under that policy group
are listed.
Date String Number of days. Only users that are registered within
that number of days are listed.
ClientType String OBM / ACB. Only that type of user is listed.
LoginNameOnly Boolean If it is true, only login name of users are returned.
ClientTypeOnly Boolean If it is true, only login name and client type of users are
returned.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
User Array If ClientTypeOnly is true, an array of UserClientType
is returned.

If LoginNameOnly is true, an array of UserLoginName

is returned.

Otherwise, an array of User is returned.

Message String Error message, exists only if status is Error.
ExptType String The type of exception, it exists only if status is Error.

www.ahsay.com AhsayCBS API Guide | 194 of 450

JSON OBJECTS

USERCLIENTTYPE

KEY TYPE DESCRIPTIONS

ID String ID Backup User
LoginName String Client user name.
Owner String Owner of the User
UserId String Unique for each user.
ClientType String ACB / OBM
QuotaUsed Integer User quota used by the user.

USERLOGINNAME

KEY TYPE DESCRIPTIONS

ID String ID of the User
LoginName String Client user name.
Owner String Owner of the User
UserId String Unique for each user
ClientType String ACB / OBM
QuotaUsed Integer User quota used by the user.

USER

KEY TYPE DESCRIPTIONS

ID String ID of the Backup User
LoginName String Client user name.
Owner String Owner of the Backup User
UserId String Unique for each user
Alias String Display name
UserType String TRIAL / PAID. Default to TRIAL if not specified.
ClientType String ACB / OBM
QuotaUsed Integer User quota used by the user.
DestinationQuotaList Array Array list of Destination Quota settings
DestinationName String Name of target destination
DestinationKey Long Encryption key for destination

www.ahsay.com AhsayCBS API Guide | 195 of 450

Online Boolean True / False
Timezone String Refer to Apendix for timezone string / ID.
Language String Language used.
Please refer to Supported Language Code
DataFile Long Number of files in data area (Exclude local
destination).
DataSize Long Compressed size of data area (Exclude local
destination).
RetainFile Long Number of files in retention area (Exclude local
destination).
RetainSize Long Compressed size of retention area (Exclude local
destination).
EnableMSSQL Boolean Add-on module of MS SQL backup.
EnableMSExchange Boolean Add-on module of MS Exchange backup.
MsExchangeQuota Long Quota of MS Exchange
EnableMsWinSysState Boolean Add-on module of Windows System State backup.
EnableOracle Boolean Add-on module of Oracle backup.
EnableLotusNotes Boolean Add-on module of Lotus Notes backup.
EnableLotusDomino Boolean Add-on module of Lotus Domino backup.
EnableMySQL Boolean Add-on module of MySQL backup.
EnableInFileDelta Boolean Add-on module of In File Delta feature.
EnableShadowCopy Boolean Add-on module of Volume Shadow Copy feature.
EnableExchangeMailbox Boolean Add-on module of Exchange Mailbox backup.
ExchangeMailboxQuota Long Quota of Exchange Mailbox
EnableNASClient Boolean Add-on module of Synology NAS backup.
EnableQnap Boolean Add-on module of QNAP NAS backup.
EnableDeltaMerge Boolean Add-on module of Delta Merge.
EnableMsVm Boolean Add-on module of Hyper-V
EnableOpenDirect Boolean Add-on module of Open Direct feature.
OpenDirectQuota Long Quota of OpenDirect module
MsVmQuota Long Quota of Hyper-V module
EnableVMware Boolean Add-on module of VMware backup.
VMwareQuota Long Number of Guest VM allowed.
Bandwidth Long Bandwidth limitation on User
Notes String Backup User notes
Status String SUSPENDED / ENABLE.
RegistrationDate Long Date of Backup User registration

www.ahsay.com AhsayCBS API Guide | 196 of 450

SuspendPaidUser Boolean True / False
SuspendPaidUserDate String Date of Backup User suspension
LastBackupDate Long Last date of Backup Job being run
EnableCDP Boolean Add-on module of Continuous Data Protection.
EnableShadowProtectBareMetal Boolean Add-on module of Shadow Protect backup.
EnableWinServer2008BareMetal Boolean Add-on module of Windows system backup.
MsVmQuotaType String GUESTVM / SOCKET
VMwareQuotaType String GUESTVM / SOCKET
EnableMobile Boolean True / False
MobileQuota Long Quota for Mobile
EnableOffice365Mail Boolean Add-on module of Microsoft 365 backup.
Office365MailQuota Long Office365 Mail Quota
Hostname String URL or Hostname used to access CBS
LdapUser String LDAP User Account
LdapDeleteUser Long Date LDAP Account was deleted in long format
LdapDisableUser Long Date LDAP Account was disabled in long format
ExpiryDate Long Expiry Date of Backup User account
LatestClientVersion String Latest version of used client
UserGroupIDList Array Array of user group ID.
UserHome String Address to the User Home directory
Contact Array Array list of contacts
QuotaList Array Array of backup quota for backup destination.
QuotaType String Quota Type, either TOTAL_QUOTA or
PER_DESTINATION_QUOTA.
StorageQuota Long Total Quota in GB. Value validity examined when
used by TOTAL_QUOTA.
EnableDeduplication Boolean Add-on module of Deduplication.
EnableTibero Boolean Add-on module of Tibero backup.
EnableLinuxBareMetal Boolean Add-on module of Linux Bare Metal

QUOTALIST

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
DestinationName String Name of the backup destination.
DestinationKey String ID of the backup destination, or OBS for quota on

www.ahsay.com AhsayCBS API Guide | 197 of 450

 AhsayCBS.
Quota Integer Unit in bytes.
Value validity examined when used by
PER_DESTINATION_QUOTA.

USERGROUP

KEY TYPE DESCRIPTIONS

UserGroupID String ID of User Group
UserGroupName String Name of User Group
ShowLink Boolean True / False

CONTACT

KEY TYPE DESCRIPTIONS

Name String Name of contact
Email String Example: [email protected]

MODULEUSAGE

KEY TYPE DESCRIPTIONS

MSExMailbox Long Usage of MSExMailbox module license.
MSHyperVVM Long Usage of MSHyper-V VM module license.
VMwareVM Long Usage of VMwareVM module license.
Office365Mail Long Usage of Office365Mail module license.
HostCount Long Usage of OBM / ACB license.

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“searchStr”:”obm”
}
OUTPUT
{
“Status”:”OK”,

www.ahsay.com AhsayCBS API Guide | 198 of 450

 “User”:[
{
“Timezone”:”1098”,
“MobileQuota”:0,
“LoginName”:”38367_new”,
“Owner”:””,
“ExpiryDate”:25,
“UserGroupIDList”:[
{
“ShowLink”:false,
“UserGroupID”:”1”,
“UserGroupName”:”All Users”
}
],
“EnableNASClient”:false,
“EnableMariaDB”:false,
“EnableOpenDirect”:false,
“DataFile”:0,
“MsVmQuotaType”:”GUESTVM”,
“EnableShadowProtectBareMetal”:false,
“LdapUser”:false,
“EnableMobile”:false,
“DataSize”:0,
“EnableLotusDomino”:false,
“UserHome”:”C:\\Users\username\Documents\cbase\user\38367_new”,
“ID”:”1703141283712”,
“MsVmQuota”:0,
“Status”:”ENABLE”,
“EnableVMware”:false,
“Office365MailQuota”:0,
“Hostname”:””,
“EnableDeduplication”:true,
“EnableMobileV2”:false,
“LdapDisableUser”:-1,
“LatestClientVersion”:””,
“EnableMSSQL”:false,
“VMwareQuotaType”:”GUESTVM”,
“EnableLinuxBareMetal”:false,
“EnableLotusNotes”:false,
“VMwareQuota”:0,
“UserType”:”PAID”,
“MobileAuthenticationSettings”:{
“MobileDeviceList”:[],
“Enable”:false
},
“ClientType”:”OBM”,
“EnableOracle”:false,
“RegistrationDate”:1703141283712,

www.ahsay.com AhsayCBS API Guide | 199 of 450

 “RecycleBinCompressed”:0,
“EnableExchangeMailbox”:false,
“QuotaList”:[
{
“DestinationKey”:”OBS”,
“Quota”:52428800,
“DestinationName”:”AhsayCBS”,
“Enabled”:true,
},
{
“DestinationKey”:”-1700008764400”,
“Quota”:0,
“Destinationname”:”OneDrive-1”,
“Enabled”:false
},
{
“DestinationKey”:”-1700025457535”,
“Quota”:0,
“DestinationName”:”OneDrive-3”,
“Enabled”:false
}
],
“EnableCDP”:false,
“EnableInFileDelta”:false,
“SuspendPaidUserDate”:”20231221”,
:MobileBackupSettings”:{
“DeviceList”:[]
},
“MobileQuotaV2”:0,
“MobileUsage”:{
“MSExMailbox”:0,
“Hostcount”:1,
“MSHyperVM”:0,
“Office365Mail”:0,
“VMwareCM”:0
},
“EnableShadowCopy”:false,
“Language”:”en”,
“Bandwidth”:0,
“StorageQutoa”:0,
“LdapDeleteUser”:-1,
“EnableMySQL”:false,
“EnableOffice365Mail”:false,
“Notes”:””,
“OpenDirectQuota”:0,
“QuotaUsed”:1,
“EnableWinServer2000BareMetal”:false,
“RetainFile”:0,

www.ahsay.com AhsayCBS API Guide | 200 of 450

 “EnableQnap”:false,
“QuotaType”:”PER_DESTINATION_QUOTA”,
“EnableMsVm”:false,
“RetainSize”:0,
“RecycleBinFileNo”:0,
“LastBackupDate”:0,
“Contact”:[],
“EnableTibero”:true,
“AzureDestinationList”:[],
“UserId”:”38367_new”,
“Alias”:””,
“ExchangeMailboxQuota”:0,
“EnableMsWinSysState”:false,
“SuspendPaidUser”:false,
“CBKGoExpiryDate”:17042976000000,
“Online”:false,
“”EnableMSExchange”:false
]
}

www.ahsay.com AhsayCBS API Guide | 201 of 450

AUTHUSER
This API checks whether a user exists or not.

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

Backup/Restore > Users, Groups & Policies > Backup User

URL
https://CBS.EXAMPLE.COM/obs/api/json/AuthUser.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of System User (if applicable)
Password Password used to login

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, exists only if status is Error.
ExptType String The type of exception, it exists only if status is Error.

www.ahsay.com AhsayCBS API Guide | 202 of 450

EXAMPLES

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”SampleUser”,
“Password”:”SamplePassword”
}
OUTPUT 1
{
“Status”:”OK”
}
OUTPUT 2: User does not exist
{
“Status”:”Error”,
“Message”:”[UserCacheManager.NoSuchUserExpt] User ‘NonExistentUser’ not
found.”,
“ExptType”:”com.ahsay.obs.core.dbs.ai”
}

www.ahsay.com AhsayCBS API Guide | 203 of 450

RUNSINGLEUSERREBUILD
This API rebuilds a particular v6 legacy backupset of a user.

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

Backup/Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set >
%v6 Backup Set Name% > Destination > Standard Destination > Rebuild

URL
https://CBS.EXAMPLE.COM/obs/api/json/AuthUser.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of System User (if applicable)
BackupSetID String ID of the backupset. Obtainable in GetBackupset API.
CheckCrc Boolean Cyclic redundancy check.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, exists only if status is Error.
ExptType String The type of exception, it exists only if status is Error.

www.ahsay.com AhsayCBS API Guide | 204 of 450

JSON OBJECTS

REBUILD STATUS

KEY TYPE DESCRIPTIONS

LoginName String Client user name.
BackupSetID String ID of Backup Set
Status String Rebuild status
StartTime Long Start time of rebuild
EndTime Long End time of rebuild

EXAMPLES

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1686639360356”
}
OUTPUT
{
“Status”:”OK”
}
OUTPUT 2: BACKUPSET DOES NOT EXIST
{
“Status”:”Error”,
“Message”:”Backup Set for ID=’1686639360356’ notfound”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 205 of 450

GETSINGLEUSERREBUILDSTATUS
This API allows you to get the information of the recent v6 legacy backupset rebuild.

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

Monitoring > Administration Logs > Audit Trails

URL
https://CBS.EXAMPLE.COM/obs/api/json/AuthUser.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of System User (if applicable)

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object Refer to JSON Objects - RebuildStatus
RebuildStatus
Message String Error message, exists only if status is Error.
ExptType String The type of exception, it exists only if status is Error.

JSON OBJECTS

REBUILDSTATUS

KEY TYPE DESCRIPTIONS

LoginName String Client user name.
BackupSetID String ID of Backup set
Status String Rebuild status
StartTime Long Rebuil Start time
EndTime Long Rebuild End time

www.ahsay.com AhsayCBS API Guide | 206 of 450

EXAMPLES

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1686639360356”
}
OUTPUT
{
“Status”:”OK”,
“Data”:{
“Status”:”Finished”,
“LoginName”:”obm”,
“EndTime”:1686640128382,
“StartTime”:1686640127867,
“BackupSetID”:”1686639360356”
}
}
OUTPUT 2: NOT YET STARTED
{
“Status”:”OK”,
“Data”:{
“Status”:”Not yet started”,
“LoginName”:”obm”,
“EndTime”:-1,
“StartTime”:-1,
“BackupSetID”:””
}
}

www.ahsay.com AhsayCBS API Guide | 207 of 450

GETUSERSTORAGESTAT
This API allows you to get the file statistic of a backup set of a user.

The related settings can be found on the AhsayCBS web console.

Backup/Restore > Users, Groups & Policies > Backup User > %User Name% > Statistics

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetUserStorageStat.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
LoginName String Client user name
Owner String Owner of system user (if applicable)
YearMonth String In “yyy-MM” format. For example, to get the storage
statistics of January 2023, the parameter is “2023-01”
BackupSetID String “all” to get statistics of all backup sets, or the backup set
ID of the backup set.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array of Array list of AverageStat settings
AverageStat
Message String Error message, exists only if status is Error.
ExptType String The type of exception, it exists only if status is Error.

www.ahsay.com AhsayCBS API Guide | 208 of 450

JSON OBJECTS

AVERAGESTAT

KEY TYPE DESCRIPTIONS

YearMonth String yyyy-MM
AvgDataSize String Average data size in k / M / G format of all backup
sets.
AvgDataRawSize String Average data size in raw byte format of all backup
sets.
AvgDataNo String Average data number
AvgRetainSize String Average retained data size in k / M/ G format of all
backup sets.
AvgRetainRawSize String Average retained data size in raw byte format of all
backup sets.
AvgRetainNo String Average retain number
AvgUploadSize String Average uploaded data size in k / M / G format of all
backup sets.
AvgUploadRawSize String Average uploaded data size in raw byte format of all
backup sets.
AvgUploadNo String Average upload number
AvgTotalStorageSize String Average total storage size in k / M / G format of all
backup sets.
AvgTotalStorageRawSize String Average total storage size in raw byte format of all
backup sets.
AvgTotalStorageNo String Average total storage number
Storage Array of DetailStat Refer to DetailStat

DETAILSTAT

KEY TYPE DESCRIPTIONS

Date String yyyy-MM-dd
DataSize String Data size in k / M / G format.
DataRawSize String Data size in raw byte format.
DataUncompressed Long Uncompressed data size in k / M / G format.
DataRawUncompressed Long Uncompressed data size in raw byte format.
DataNo String
RetainSize String Retained data size in k / M / G format.

www.ahsay.com AhsayCBS API Guide | 209 of 450

RetainRawSize String Retained data size in raw byte format.
RetainUncompressed String Uncompressed retained data size in k / M / G
format.
RetainRawUncompressed String Uncompressed retained data size in raw byte
format.
RetainNo String Retain number
UploadSize String Uploaded data size in k / M / G format.
UploadRawSize String Uploaded data size in raw byte format.
UploadUncompressed String Uncompressed uploaded data size in k / M / G
format.
UploadRawUncompressed String Uncompressed uploaded data size in raw byte
format.
UploadNo String Upload number
TotalStorageSize String Total storage size in k / M / G format.
TotalStorageRawSize String Total storage size in raw byte format.
TotalStorageUncompressed String Uncompressed total storage size in k / M / G
format.
TotalStorageRawUncompressed String Uncompressed total storage size in raw byte
format
TotalStorageNo String Total storage number
DestinationID String Desintation storage ID.

www.ahsay.com AhsayCBS API Guide | 210 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“YearMonth”:”2023-06”
}
OUTPUT
{
“Status”:”OK”,
“Data”:{
“AvgDataRawSize”:”5504624”,
“AvgUploadRawSize”:”5504624”,
“AvgRetainRawSize”:”0”,
“AvgRetainUncompressed”:”0”,
“AvgTotalStorageUncrompressed”:”0”,
“AvgUploadSize”:”5.25 M”,
“AvgDataRawUncompressed”:”5.9 M”,
“AvgDataUncompressed”:”5.9 M”,
“AvgRetainSize”:”0”,
“AvgTotalStorageSize”:”5.25 M”,
“AvgTotalStorageRawUncompressed”:”6183694”,
“AvgUploadUncompressed”:”5.9 M”,
“AvgUploadNo”:”53”,
“AvgTotalStorageNo”:”39”,
“Storage”:[
{
“UploadRawSize”:”5504624”
“TotalRestoreSize”:0,
“DataRawUncompressed”:”6183694”,
“DataUncompressed”:”5.9 M”,
“UploadRawUncompressed”:”6183694”,
“TotalStorageNo”:”39”,
“UploadNo”:”39”,
“UploadSize”:”5.25 M”,
“DataSize”:”5.25 M”,
“TotalStorageRawSize”:”5504624”,
“RetainRawUncompressed”:”0”,
“TotalRestoreFileNo”:”0”,
“TotalBackupSize”:”5.25 M”,
“RetainUncompressed”:”0”,
“TotalStorageUncompressed”:”5.9 M”,
“RetainSize”:”0”,

www.ahsay.com AhsayCBS API Guide | 211 of 450

 “RetainRawSize”:”0”,
“DestinationID”:””,
“Date”:”2023-06-14”,
“TotalStorageSize”:”5.25 M”,
“RetainNo”:”0”,
“UploadUncompressed”:”5.9 M”,
“TotalStorageRawUncompressed”:”6183694”,
“DataNo”:”39”,
“TotalBackupFileNo”:”39”,
“DataRawSize”:”5504624”
}
],
“YearMonth”:”2023-06”,
“AvgUploadRawUncompressed”:”6183694”,
“AvgRetainRawUncompressed”:”0”,
“AvgRetainNo”:”0”,
“AvgTotalStorageRawSize”:”5504624”,
“AvgDataNo”:”39”
}
}

EXAMPLE 2 – NO STORAGE LOG FOUND

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“YearMonth”:”2023-01”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”No storage log found”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 212 of 450

UPDATEUSERPROFILE (V1), UPDATEUSER (V2)
This API updates the information of a user profile.

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

Backup/Restore > Users, Groups & Policies > Backup user > %User name%

V1 UPDATEUSERPROFILE.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateUserProfile.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 UPDATEUSER.DO

To facilitate the Quota Management feature, a new version of the UpdateUserProfile.do API (v2
UpdateUser.do) was introduced.

NOTE
The name of the v1 UpdateUserProfile.do API has changed to UpdateUser.do

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/UpdateUser.do
AVAILABLE SINCE VERSION:
9.5
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of System User (if applicable)
Alias String System User alias (if applicable)
Status String SUSPENDED or ENABLE (Default)
Type String TRIAL or PAID. Default to TRIAL if not
specified.

www.ahsay.com AhsayCBS API Guide | 213 of 450

ClientType String ACB or OBM
Password String Password of the user account.
Language String Language used by the client user.
Notes String User notes
QuotaList JSON object Refer to QuotaList
HostQuotaEnabled Boolean Enable / Disable Client host.
HostQuota Long Client host limit.
RunDirectQuotaEnabled Boolean True / False
RunDirectQuota Long Quota for RunDirect module
ModuleSettings JSON object Used to assign modules.
WindowsEventLogSettings WindowsEventLogSettings Log
Contact Array If "AppendContact" is "Y", all contacts in
the array will be appended to the contacts.
AppendContact String "Y" or "N" to modify an existing contact
(retrieve the corresponding keys required
with the GetUser.do API).
ChangeContact String "Y" or "N" to change and overwrite an
existing (retrieve the corresponding keys
required with the GetUser.do API).
OldContact Array Existing contacts. It is used if
"ChangeContact" is "Y".
NewContact Array If "ChangeContact" is "Y", all contacts in
OldContact will be updated with
NewContact.
SecuritySettings JSON object Parameter available only if global MFA
Setting is ON.
Update to PhoneList array is by
replacement of whole list.
Note: If modifying the PhoneList, most
recent phone number (based on
LastSuccessfulLoginInfo “PhoneNumber”)
cannot be removed by API, due to API
validation check. That phone number must
be included when updating PhoneList.
QuotaType String Quota Type, either TOTAL_QUOTA or
PER_DESTINATION_QUOTA.
StorageQuota Long Total Quota in GB. Value validity examined
when used by TOTAL_QUOTA.
EnableAUA Boolean Toggle user’s Auto Update Agent setting.

www.ahsay.com AhsayCBS API Guide | 214 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, exists only if status is
“Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

MODULESETTINGS

KEY TYPE DESCRIPTIONS

MSExchangeMailboxBackupEnabled Boolean Defines whether module MS Exchange
Mailbox backup will be enabled.
MSExMailboxQuota Long Quota for MSExchangeMailBox
MSSQLBackupEnabled Boolean Defines whether module MS SQL backup
will be enabled.
MSExchangeBackupEnabled Boolean Defines whether module MS Exchange
backup will be enabled.
OracleBackupEnabled Boolean Defines whether module Oracle backup
will be enabled.
LotusDominoBackupEnabled Boolean Defines whether module Lotus Domino
backup will be enabled.
LotusNotesBackupEnabled Boolean Defines whether module Lotus Notes
backup will be enabled.
MySQLBackupEnabled Boolean Defines whether module MySQL backup
will be enabled.
InFileDeltaEnabled Boolean Defines whether module In-File Delta will
be enabled.
ShadowCopyEnabled Boolean Defines whether module ShadowCopy will
be enabled.
NasClientEnabled Boolean Defines whether module Synology NAS
Client will be enabled.
QnapEnabled Boolean Defines whether module QNAP will be
enabled.
DeltaMergeEnabled Boolean True / False
MSHyperVBackupEnabled Boolean Defines whether module MS HyperV
backup will be enabled.

www.ahsay.com AhsayCBS API Guide | 215 of 450

MSHyperVVMQuota Long Defines module MS HyperV VM quota.
MSHyperVVMQuotaType String GUESTVM or SOCKET
VMwareBackupEnabled Boolean Defines whether module VMWare backup
will be enabled.
VMwareVMQuota Long Defines module VMWare VM quota.
VMwareVMQuotaType String GUESTVM or SOCKET
CDPEnabled Boolean Defines whether module CDP will be
enabled.
ShadowProtectBackupEnabled Boolean Defines whether module ShadowProtect
backup will be enabled.
MSWindowsSystemBackupEnabled Boolean Defines whether module MS Windows
System backup will be enabled.
MSWindowsSystemStateBackupEnabled Boolean Defines whether module MS Windows
System State backup will be enabled.
Office365MailEnabled Boolean Defines whether module Microsoft 365
Mail backup will be enabled.
Office365MailQuota Long Note: ACB user type limited to 2
MobileEnabled Boolean Deprecated from v8.5; no new mobile v1
modules can be Enabled for users.
MobileV2Enabled Boolean Defines whether modules MobileV2 will be
enabled .
MobileQuota Long Deprecated from v8.5.
MobileQuotaV2 Long Fixed at 10 regardless of input value.
OpenDirectEnabled Boolean Defines whether module OpenDirect will
be enabled.
OpenDirectQuota String Defines module OpenDirect quota.
MariaDBBackupEnabled Boolean Defines whether module MariaDB backup
will be enabled.
DeduplicationEnabled Boolean Defines whether module Deduplication will
be enabled.
TiberoBackupEnabled Boolean Defines whether module Tibero Database
Server backup will be enabled.
LinuxBareMetalBackupEnabled Boolean Defines whether module Linux Bare Metal
backup will be enabled.

www.ahsay.com AhsayCBS API Guide | 216 of 450

CONTACT

KEY TYPE DESCRIPTIONS

Company String Company where contact is from
Email String Contact E-mail address
Address String Address of contact
Website String Website of contact
Name String Contact name
Phone1 String Contact Phone number
Phone2 String Contact Phone number

WINDOWSEVENTLOGSETTINGS

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
LogError Boolean Log type
LogProfile Boolean Log option
LogServices Boolean Log option
LogUtilities Boolean Log option
LogBackup Boolean Log option
LogSoftwareUpdate Boolean Log option
LogReport Boolean Log option
LogLoginLogout Boolean Log option
LogInfo Boolean Log type
LogBuy Boolean Log option
LogLicense Boolean Log type
LogWarn Boolean Log type
LogRestore Boolean Log option

QUOTALIST

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
Quota Long Quota of the backup destination, unit in
byte.
Value validity examined when used by
PER_DESTINATION_QUOTA.
DestinationKey String Key of the backup destination.

www.ahsay.com AhsayCBS API Guide | 217 of 450

USERSUSPENDSETTINGS

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
Date String Date in Unix time.

SYSTEMSETTINGS

KEY TYPE DESCRIPTIONS

Enable Boolean True / False
PhoneList Array Array list of phone numbers
Country Code Long Country Code
PhoneNumber String SMS phone number.
Verified Boolean Not applicable by API. Default value
“False”.
VerifiedTime Long Not applicable by API.
Id String Not applicable by API.

EXAMPLES

EXAMPLE 1

INPUT – Update Quota Setting

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“QuotaList”:[
{
“Enabled”:true,
“DestinationKey”:”OBM”,
“Quota”:73400320
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 218 of 450

EXAMPLE 2

INPUT – Add Contacts (ChangeContact (Y))

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“ChangeContact”:”Y”,
“NewContact”:[{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”newcontact1”,
“Website”:”www.ahsay.com”,
“Name”:”newcontact1”,
“Phone1”:”1234”,
“Phone2”:”1234”
},
{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”newcontact2”,
“Website”:”www.ahsay.com”,
“Name”:”newcontact2”,
“Phone1”:”1234”,
“Phone2”:”1234”
}]
}
OUTPUT – Contacts ‘newcontact1’ and ‘newcontact2’ are added
{
“Status”:”OK”
}

EXAMPLE 3

INPUT – Update Contact (ChangeContact (Y))

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“ChangeContact”:”Y”,
“OldContact”:[{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”oldcontact1”,
“Website”:”www.ahsay.com”,

www.ahsay.com AhsayCBS API Guide | 219 of 450

 “Name”:”oldcontact1”,
“Phone1”:”1234”,
“Phone2”:”1234”
},
{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”oldcontact2”,
“Website”:”www.ahsay.com”,
“Name”:”oldcontact2”,
“Phone1”:”1234”,
“Phone2”:”1234”
}],
“NewContact”:[{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”newcontact1”,
“Website”:”www.ahsay.com”,
“Name”:”newcontact1”,
“Phone1”:”1234”,
“Phone2”:”1234”
},
{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”newcontact2”,
“Website”:”www.ahsay.com”,
“Name”:”newcontact2”,
“Phone1”:”1234”,
“Phone2”:”1234”
}]
}
OUTPUT – ‘oldcontact1’ and ‘oldcontact2’ have been updated to ‘newcontact1’ and ‘newcontact2’
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 220 of 450

EXAMPLE 4

INPUT – Delete Contact (ChangeContact (Y))

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“ChangeContact”:”Y”,
“OldContact”:[{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”oldcontact1”,
“Website”:”www.ahsay.com”,
“Name”:”oldcontact1”,
“Phone1”:”1234”,
“Phone2”:”1234”
},
{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”oldcontact2”,
“Website”:”www.ahsay.com”,
“Name”:”oldcontact2”,
“Phone1”:”1234”,
“Phone2”:”1234”
},
{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”newcontact1”,
“Website”:”www.ahsay.com”,
“Name”:”newcontact1”,
“Phone1”:”1234”,
“Phone2”:”1234”
},
{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”newcontact2”,
“Website”:”www.ahsay.com”,
“Name”:”newcontact2”,
“Phone1”:”1234”,
“Phone2”:”1234”
}],
“NewContact”:[{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”oldcontact1”,

www.ahsay.com AhsayCBS API Guide | 221 of 450

 “Website”:”www.ahsay.com”,
“Name”:”oldcontact1”,
“Phone1”:”1234”,
“Phone2”:”1234”
},
{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”oldcontact2”,
“Website”:”www.ahsay.com”,
“Name”:”oldcontact2”,
“Phone1”:”1234”,
“Phone2”:”1234”
},
{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”newcontact2”,
“Website”:”www.ahsay.com”,
“Name”:”newcontact2”,
“Phone1”:”1234”,
“Phone2”:”1234”
}]
}
OUTPUT – ‘newcontact1’ deleted
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 222 of 450

EXAMPLE 5

INPUT – Append contacts with duplication (AppendContact (Y))

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“AppendContact”:”Y”,
“Contact”:[{
“Company”:”Ahsay”,
“Email”:”[email protected]”,
“Address”:”oldcontact1”,
“Website”:”www.ahsay.com”,
“Name”:”oldcontact1”,
“Phone1”:”1234”,
“Phone2”:”1234”
}]
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[UpdateUserProfile.checkDuplicatedEmail] Contact already
exists <[email protected]>”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 223 of 450

EXAMPLE 6

INPUT – Append contacts without duplication (AppendContact (Y))

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“AppendContact”:”Y”,
“Contact”:[{
“Company”:”None”,
“Email”:”[email protected]”,
“Address”:”oldcontact”,
“Website”:”www.ahsay.com”,
“Name”:”oldcontact”,
“Phone1”:”1234”,
“Phone2”:”1234”
}]
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 7

INPUT – Delete all contacts (AppendContact (N))

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“AppendContact”:”N”,
“Contact”:[{
“Company”:”None”,
“Email”:”[email protected]”,
“Address”:”oldcontact”,
“Website”:”www.ahsay.com”,
“Name”:”oldcontact”,
“Phone1”:”1234”,
“Phone2”:”1234”
}]
}
OUTPUT – All other contacts except for ‘[email protected]’ is deleted
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 224 of 450

EXAMPLE 8

INPUT – Replace all contacts (AppendContact (N))

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“AppendContact”:”N”,
“Contact”:[{
“Company”:”None”,
“Email”:”[email protected]”,
“Address”:”oldcontact”,
“Website”:”www.ahsay.com”,
“Name”:”oldcontact”,
“Phone1”:”1234”,
“Phone2”:”1234”
}]
}
OUTPUT – Contacts without the email ‘[email protected]’ are replaced / deleted
{
“Status”:”OK”
}

EXAMPLE 9

INPUT – Change module settings

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“ModuleSettings”:{
“ShadowCopyEnabled”:true,
“NasClientEnabled”:true,
“DeduplicationEnabled”:false
}
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 225 of 450

EXAMPLE 10

INPUT – Change subscription type to ‘PAID” and disable ‘suspend at’ option
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“Type”:”PAID”,
“UserSuspendSettings”:{
“Enabled”:”false”,
“Date”:2106396800000,
}
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 11

INPUT – Add or change MFA phone number or Enable

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“Type”:”PAID”,
“UserSuspendSettings”:{
“Enabled”:”false”,
“Date”:2106396800000,
}
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 226 of 450

ADDCONTACT
This API adds new contact information to a user.

The related settings can be found on the AhsayCBS web console.

Backup/Restore > Users, Groups & Policies > Backup user > %User name% > User Profile >
Contact

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddContact.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of System User (if applicable)
NewContact JSON Object Contact See Contact

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, exists only if status is
“Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 227 of 450

JSON OBJECTS

CONTACT

KEY TYPE DESCRIPTIONS

Name String Name of Contact
Email String Example: [email protected]

EXAMPLES

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“NewContact”:{
“Name”:”contact1”,
“Email”:”[email protected]”
}
}
OUTPUT
{
“Status”:”OK”
}
OUTPUT 2 – Duplicate contact email
{
“Status”:”Error”,
“Message”:”[UpdateUserProfile.checkDuplicatedEmail] Contact already
exists <[email protected]>",
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 228 of 450

ADDUSER (V1, V2)
This API can be used to add new backup user.

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

Backup / Restore > Users, Groups & Policies > Backup user

V1 ADDUSER.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddUser.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 ADDUSER.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/AddUser.do
AVAILABLE SINCE VERSION:
9.5
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of System User (if applicable)
Password String Password to login
Email String Contact Email
QuotaList JSON Object Array See QuotaList
Status String If this valus is “SUSPENDED”, the user is
suspended. Otherwise, the user is
enabled.
ClientType String ACB or OBM
Type String TRIAL or PAID. Default to TRIAL if not
specified.
UserHome String Default to the first user home on your
user home configuration if not specified.

www.ahsay.com AhsayCBS API Guide | 229 of 450

 You can find the User home
configuration in your CBS console:
[Backup / Restore] > [Basic] > [User
Home]
MobileQuota Long Deprecated from v8.5, old v1 AhsayMOB
quota.
MobileV2Quota Long Fixed at 10 regardless of input.
ExchangeMailboxQuota Long Exchange mail level backup quota.

Mandatory if the corresponding add-on

module is enabled (e.g.
“ExchangeMailboxQuota” is mandatory if
“EnableExchangeMailbox” is set to true).
MsVmQuota Long Hyper-V VM backup quota.

Mandatory if the corresponding add-on

module is enabled (e.g. “MsVmQuota” is
mandatory if “EnableMsVm” is set to
true).
MsVmQuotaType String The value can be any one of the
following:

GUESTVM
SOCKET

Default value is GUESTVM if not provided

VMwareQuota Long VMware VM backup quota.

Mandatory if the corresponding add on

module is enabled (e.g. "VmwareQuota"
is mandatory if "EnableVMware" is set to
true).
VMwareQuotaType String The value can be any one of the
following:

GUESTVM
SOCKET

Default value is GUESTVM if not provided

RunDirectQuotaEnabled Boolean True / False
RunDirectQuota Long Run Direct maximum VM quota.

www.ahsay.com AhsayCBS API Guide | 230 of 450

 Mandatory if the RunDirect is enabled
(e.g. "RunDirectQuota" is mandatory if
"RunDirectQuotaEnabled" is set to true).
EnableOffice365Mail Boolean True / False
Office365MailQuota Long Microsoft 365 mail backup quota.

Mandatory if the corresponding add on

module is enabled (e.g.
"Office365MailQuota" is mandatory if
"EnableOffice365Mail" is set to true).
Language String Language used by the user.
DisplayName String Alias and Contact name. You are highly
recommended to fill this.
Notes String Account profile Notes field.
HostQuotaEnabled Boolean Storage quota, Unit in bytes.
HostQuota Long Enable or disable Client host quota.
EnableMobile Boolean AhsayMOB module -- Deprecated from
v8.5
EnableMobileV2 Boolean Enable or disable Ahsay Mobile module
(when enabled, “MobileV2Quota” fixed
value at 10).
EnableExchangeMailbox Boolean Enable or disable Exchange Mailbox
module.
EnableMSSQL Boolean Enable or disable MS SQL module.
EnableMSExchange Boolean Enable or disable MS Exchange module.
EnableOracle Boolean Enable or disable Oracle module.
EnableLotusDomino Boolean Enable or disable Lotus Domino module.
EnableLotusNotes Boolean Enable or disable Lotus Notes module.
EnableMySQL Boolean Enable or disable MySQL module.
EnableInFileDelta Boolean Enable or disable In-File Delta module
(pre-v9).
EnableShadowCopy Boolean Enable or disable Shadow Copy module.
EnableNASClient Boolean Enable or disable Synology module.
EnableQnap Boolean Enable or disable QNAP module.
EnableMsVm Boolean Enable or disable HyperV module.
EnableVMware Boolean Enable or disable VMware module.
EnableCDP Boolean Enable or disable CDP module.
EnableShadowProtectBareMetal Boolean Enable or disable ShadowProtect
module.

www.ahsay.com AhsayCBS API Guide | 231 of 450

EnableWinServer2008BareMetal Boolean Enable or disable Windows system back
up.
EnableMsWinSysState Boolean Enable or disable Windows system state
backup.
EnableOpenDirect Boolean Enable or disable OpenDirect.
OpenDirectQuota String Number of OpenDirect allowed
EnableMariaDB Boolean Enable or disable MariaDB module.
EnableDeduplication Boolean Enable or disable Deduplication module.
QuotaType String Quota Type, either TOTAL_QUOTA or
PER_DESTINATION_QUOTA, default to
PER_DESTINATION_QUOTA, if not
specified.
StorageQuota Long Default to 100, if not specified. Unit in GB
QuotaList JSON Object Array Mandatory if QuotaType is
PER_DESTINATION_QUOTA or if
QuotaType is not specified.
EnableAUA Boolean Toggle user’s Auto Update Agent setting.
EnableTibero Boolean Enable or disable Tibero Database
module.
EnableLinuxBareMetal Boolean Enable or disable Linux Bare Metal
module.

QUOTALIST

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
DestinationKey String ID of the predefined destination, or
“OBS” for quota on AhsayCBS.
Quota Long Unit in bytes.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, exists only if status is “Error”.
ExptType String The type of exception, will only be displayed if the
status is “Error”.

www.ahsay.com AhsayCBS API Guide | 232 of 450

EXAMPLES

EXAMPLE 1

INPUT – Add OBM paid user with AhsayCBS quota 50 GB and predefined destination quota of 50 GB
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm2”,
“Password”:”obm2”,
“Email”:[email protected],
“Type”:”Paid”:,
“Status”:”ENABLE”,
“ClientType”:”OBM”,
“QuotaList”:[
{
“Enabled”:true,
“DestinationKey”:”OBS”,
“Quota”:53687091200
},
{
“Enabled”:true,
“DestinationKey”:”-1686812937526”,
“Quota”:53687091200
}
]
}
OUTPUT
{
“Status”:”OK”
}
OUTPUT 2 – If destination is not visible to user
{
“Status”:”Error”,
“Message”:”Destination ‘-1686812937526’ is not visible to user ‘obm2’
according to policy’s [Destinations Visible to Users] settings.”,
“ExptType”:”java.lang.Exception”
}
OUTPUT 3 – If the Enable parameter is missing from a destination in the QuotaList
{
“Status”:”Error”,
“Message”:”Value ‘Enabled’ is missing in item ‘-1686812937526’ of
‘QuotaList’.”,
“ExptType”:”java.lang.Exception”
}
OUTPUT 4 – If the Enable is invalid for a destination in the QuotaList

www.ahsay.com AhsayCBS API Guide | 233 of 450

{
“Status”:”Error”,
“Message”:”Invalid ‘Enabled’ in item ‘-1686812937526’ of ‘QuotaList’.,
“ExptType”:”java.lang.Exception”
}
OUTPUT 5 – If a destination is duplicated in the QuotaList
{
“Status”:”Error”,
“Message”:”Duplicated DestinationKey (-1686812937526) are not allowed in
the QuotaList.”,
“ExptType”:”java.lang.Exception”
}
OUTPUT 6 – If the Quota value for a destination is invalid (e.g. a negative number)
{
“Status”:”Error”,
“Message”:”Invalid value for ‘Quota’ for item ‘-1686812937526’ of
‘QuotaList’. Error: Must be a positive number.”,
“ExptType”:”java.lang.Exception”
}
OUTPUT 7 – If the Quota value for a destination is invalid
{
“Status”:”Error”,
“Message”:”Invalid value ‘Quota’ for item ‘-1686812937526’ of
‘QuotaList’. Error: JSONObject [\”Quota\”] is not a long (class
java.lang.String: ac130).”
“ExptType”:”java.lang.Exception”
}

EXAMPLE 2

INPUT – Add OBM paid user with AhsayCBS quota 50 GB and Total Quota 75 GB
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm1”,
“Password”:”obm1”,
“Email”:”[email protected]”,
“Type”:”Paid”,
“Status”:”ENABLE”,
“ClientType”:”OBM”,
“QuotaType”:”TOTAL_QUOTA”,
“StorageQuota”:75,
“QuotaList”:[
{
“DestinationKey”:”OBS”,

www.ahsay.com AhsayCBS API Guide | 234 of 450

 “Quota”:53687091200,
“DestinationName”:”AhsayCBS”,
“Enabled”:true
}
]
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 3

INPUT – Invalid Quota value specified

{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm2”,
“Password”:”obm2”,
“Email”:”[email protected]”,
“Type”:”Paid”:,
“Status”:”ENABLE”,
“ClientType”:”OBM”,
“QuotaList”:[
{
“Enabled”:true,
“DestinationKey”:”OBS”,
“Quota”:53687091200
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 235 of 450

GETUSER (V1, V2)
This API can be used to retrieve the information of a backup user.

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

Backup / Restore > Users, Groups & Policies > Backup user > %User Name%

V1 GETUSER.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetUser.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 GETUSER.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/GetUser.do
AVAILABLE SINCE VERSION:
9.7.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of System User (if applicable)

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 236 of 450

JSON OBJECTS

USER

KEY TYPE DESCRIPTIONS

AccessToken String Client API token that’s used by OBC,
should have no use to customers.
AdGroup String Legacy v6 Advertisement group (not used
by CBS).
AdGroups Array Legacy v6 Advertisement groups (not
used by CBS).
Alias String Alias.
BackupSetIdList Array ID number of each BackupSet.
Bandwidth Long V6 Bandiwdth
ClientRunVersion String Client version used by User
ClientType String ACB or OBM
ComputerNameDirList Array Path to %USERHOME%/db/ClientLogs/
Contact List JSON Object See ContactList
Array
DoubleEncodedName String Gets the double URL encoded name of
the Backup User
EmailReportSettings JSON Object See EmailReportSettings
EncodedName String Encoded User Name.
File String Path to users.xml.
ForgotPasswordSettings JSON Object See ForgotPasswordSettings
For legacy v6 backup sets.
The value is only set with the value of
FullName String
"LongLoginName" for get profile request
received from Backup Client .
GroupPolicySettings JSON Object See GroupPolicySettings
HashedPassword Boolean Legacy, unused by CBS.
HomeDir String Path of the User Home.
HostCount Integer Current client host limit in use.
Number of CPU in client computer of
HostInfo JSON Object each Run on Client BackupSet and Owner
of each Run on Client BackupSet.
Hostname String CBS server host name.
HostQuota Long Client host limit.
HostQuotaEnabled Boolean True / False

www.ahsay.com AhsayCBS API Guide | 237 of 450

HostSet JSON Object See HostSet
Id Long Millisecond time format.
Millisecond time format (0 = Not
ImportDate Long
imported user).
Language used. Refer to Supported
Language String
Language Code
LastClientLoginTime Long Millisecond time format.
LastLoginTime Long Millisecond time format.
LastShowingLicViolationTime Long License violation time
Info about the successful login by the
LastSuccessfulLoginInfo JSON Object user including IP Address, application &
time.
LdapSettings JSON Object See LdapSettings
Locked Boolean True / False
Whether account is locked due too many
LockedByMFA Boolean
MFA failure by wrong passcode.
If user is owned by Sub-Admin the
response will include the Username
LongLoginName String
appended with Sub-Admin ID number
(example, JohnDoe#12345).
MailboxUsage Integer Count for Mailbox usage
ModuleSettings JSON Object See ModuleSettings
ModulesSettings JSON Object See ModulesSettings
MoveUserHomeRecord JSON Object Record for moving User Home.
Name String User name
Backup Set name when Default Backup
NewBSetName String
Set Name policy setting is disabled.
Notes String User Notes
OpenDirectUsageCount Integer Count for OpenDirect usage
Owner String Owner of User
Password String Hashed password
PasswordHistory JSON Object See PasswordHistory
PreV7 Boolean True / False
ProxySettings JSON Object See ProxySettings
JSON Object
QuotaList Array list (see QuotaList)
(Array)
RegistrationDate Long Timestamp of registration date.
RegistrationDate Long Timestamp in milliseconds time format.

www.ahsay.com AhsayCBS API Guide | 238 of 450

RoutineJobsSetting JSON Object See RoutineJobsSettings
RunDirectQuota Integer Quota for RunDirect
RunDirectQuotaEnabled Boolean True / False
SavePassword Boolean True / False
For client to handle
SecurityIdentifier String
Schedule/CDP/Reminder in Windows
V8.3
SecuritySetting Entity of the backup user
SecuritySettings JSON Object
including the phone list, whether
individual MFA is enabled or not, etc.
Settings for returning to backup client
ServerSettings JSON Object
only.
SoftwareUpdateSettings JSON Object See SoftwareUpdateSettings
Status String Suspended or Enable
Suspend Date for Paid/Trial User in
SuspendPaidUserDate String
YYYYMMDD.
Refer to Appendix for timezone string /
Timezone String
ID.
TopDir String Path to User Home.
TotalStatistics JSON Object See TotalStatistics
TrialDays Long Days for Trial
TRIAL or PAID. Default to TRIAL if not
Type String
specified.
Whether user was updated in cache but
Updated Boolean
not yet saved to users.xml.
UploadEncryptionKey Boolean True / False
UserHome String User Home path.
UserId String Client user name.
UserLockSettings JSON Object See UserLockSettings
UserSuspendSettings JSON Object See UserSuspendSettings
Path to v6 Profile.xml (regardless if CBS
V6File String
created user, or import).
WindowsEventLogSettings JSON Object See WindowsEventLogSettings
QuotaType String Quota Type, either TOTAL_QUOTA or
PER_DESTINATION_QUOTA.
StorageQuota Long Total Quota in GB.
EnableAUA boolean Toggle user’s Auto Update Agent setting.

www.ahsay.com AhsayCBS API Guide | 239 of 450

QUOTALIST

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
DestinationName String Name of the backup destination.
DestinationKey String ID of the predefined destination, or
“OBS” for quota on AhsayCBS.
Quota Long Unit in bytes.

CONTACTLIST

KEY TYPE DESCRIPTIONS

Company String Company name of Contact
Email String Example: [email protected]
Address String Street address
EmailCertificate String Email Certificate of Contact
Website String Website of contact
Name String Name of contact
Phone1 String Phone number of contact
Phone2 String Phone number of contact
EncryptEmail Boolean True / False

EMAILREPORTSETTINGS

KEY TYPE DESCRIPTIONS

SendBkpRpt Boolean True / False
Usage Long Usage statistic
SmtpAuthUser String
ReportSenderEmail String Report Sender email
SendBkpRptMode String Mode for Sending backup reports
SmtpHostName String SMTP Host Name
MissedBkpInterval Long Missed backup intervals
SmtpPort String Port used for SMTP (e.g. 8629)
SendMissedBkpRpt Boolean True / False
SendStorageAlert Boolean True / False
SmtpAuthPwd String Password for SMTP

www.ahsay.com AhsayCBS API Guide | 240 of 450

Email String Email address used
Enabled Boolean True / False

FORGETPASSWORDSETTINGS

KEY TYPE DESCRIPTIONS

RequestTime Long Time requested
ResetTime Long Time reset

GROUPOLICYSETTING

KEY TYPE DESCRIPTIONS

UserGroupIDList Array Assigned User Group(s) ID.
ExcludeNetworkShare Boolean Legacy. v6 Policy group option, not
available to update/use in CBS.
GroupQuota Integer/Long Group quota backups
UsedGroupQuota Integer/Long Total group quota used
FileSizeLimit Long Files restricted to specified size

HOSTINFO

KEY TYPE DESCRIPTIONS

Hosts Array CPUSocketNum = Integer
Hostname = String

HOSTSET

KEY TYPE DESCRIPTIONS

“String”:“string” String Contains hostname of device installed
with client.
Example: “”:”” = no client agent
Example: “mypc”:”mypc” = client
installed on host ‘mypc’

www.ahsay.com AhsayCBS API Guide | 241 of 450

LASTSUCCESSFULLOGININFO

KEY TYPE DESCRIPTIONS

Type String OS + Browser, or Client Type.
PhoneNumber Long If MFA
IpAddress String IP
Time Long Timestamp in millisecond time format.
Id Long Timestamp in millisecond time format
(Auto-generate).

LDAPSETTINGS

KEY TYPE DESCRIPTIONS

LdapUser Boolean True / False
LastDeleteTime Long Time last deleted
LastDisableTime Long Time last disabled
FirstAuthFailureTime Long Time of first authentication failure

MODULESETTINGS

KEY TYPE DESCRIPTIONS

CDPEnabled Boolean If feature is enabled.
DeduplicationEnabled Boolean If feature is enabled.
DeltaMergeEnabled Boolean If feature is enabled.
InFileDeltaEnabled Boolean If feature is enabled.
LotusDominoBackupEnabled Boolean If feature is enabled.
LotusNotesBackupEnabled Boolean If feature is enabled.
MariaDBBackupEnabled Boolean If feature is enabled.
If AhsayMOB is enabled (deprecated
MobileEnabled Boolean
v8.5+).
Quota value for AhsayMOB (deprecated
MobileQuota Long
v8.5+).
MobileV2Enabled Boolean If AhsayMobile feature is enabled.
Value fixed at 10 when
MobileV2Quota Long
MobileV2Enabled=true.
MSExchangeBackupEnabled Boolean If feature is enabled.
MSExchangeDAGServerQuota Long Quota value

www.ahsay.com AhsayCBS API Guide | 242 of 450

 If Microsoft Exchange Mailbox feature is
MSExchangeMailboxBackupEnabled Boolean
enabled
Quota value for Microsoft Exchange
MSExMailboxQuota Long
Mailbox module.
MSHyperVBackupEnabled Boolean If feature is enabled.
MSHyperVVMQuota Long Quota value
MSHyperVVMQuotaType String Per GuestVM or Per Socket
MSSQLBackupEnabled Boolean If feature is enabled.
MSWindowsSystemBackupEnabled Boolean If feature is enabled.
MSWindowsSystemStateBackupEnabled Boolean If feature is enabled.
MySQLBackupEnabled Boolean If feature is enabled.
NasClientEnabled Boolean If Synology NAS feature is enabled.
Office365MailEnabled Boolean If feature is enabled.
Office365MailQuota Long Quota value
OpenDirectEnabled Boolean If feature is enabled.
OpenDirectQuota Long Quota value
OracleBackupEnabled Boolean If feature is enabled.
QnapEnabled Boolean If QNAP NAS feature is enabled.
ShadowCopyEnabled Boolean If feature is enabled.
ShadowProtectBackupEnabled Boolean If feature is enabled.
VMwareBackupEnabled Boolean If feature is enabled.
VMwareVMQuota Long Quota value
VMwareVMQuotaType String Per GuestVM or Per Socket

PASSWORDHISTORY

KEY TYPE DESCRIPTIONS

PasswordLastModifiedTime Long Time Password was last modified
HistoryList Array Array list of Password history

MOVEUSERHOMERECORD

KEY TYPE DESCRIPTIONS

Dest String Destination User Home path.
StartTime Long Millisecond time format.
Source String Source User Home path.

www.ahsay.com AhsayCBS API Guide | 243 of 450

PROXYSETTINGS

KEY TYPE DESCRIPTIONS

Type String Proxy type
Username String Proxy username used to login
Port String Port for Proxy
Enabled Boolean True / False
Host String Hostname or IP of Proxy
Password String Password used to login to Proxy

ROUTINEJOBSETTINGS

KEY TYPE DESCRIPTIONS

QuotaRemindPercentage Long Backup quota reminder to user if backup
quota is over a certain percentage
InactiveReportLastSentTime Long Report of time last report was sent

SECURITYSETTINGS

KEY TYPE DESCRIPTIONS

UserLockSetting Object See UserLockSettings
Id String ID of User
LastFailureTime Long Time of last failure
LockedTime Long Time user has been locked
LoginFailureCount Long Number of failed logins
PhoneList Array Array list of registered phones
Id Long ID of Phone
Verified Boolean True / False
VerifiedTime Long Time phone was verified
PhoneNumber Long Phone number
CountryCode Long Country code of phone number
Enable Boolean True / False
SendLimitSettings Object
LastSendTime Long
SendCount Integer
RecoverySettings Object List of settings for recovery
Token String Special Key for recovery of User Account
ExpiryTime Long Time Limit where Token is valid

www.ahsay.com AhsayCBS API Guide | 244 of 450

TOTALSTATISTICS

KEY TYPE DESCRIPTIONS

RetentionAreaUncompressedSize Long Uncompressed size of Retention Area
DataAreaFileCount Integer File count of Data Area
DataAreaUncompressedSize Long Uncompressed size of Data Area
DataAreaCompressedSize Long Compressed size of Data Area
RetentionAreaCompressedSize Long Compressed size of Retention Area
RetentionAreaFileCount Integer File count of Retention Area
Total uncompressed size of all the user’s
TotalRecycleBinUncompressedSize Long
backup sets in recycle bin.
Total compressed size of all the user’s
TotalRecycleBinCompressedSize Long
backup sets in recycle bin.
Total file count of all the user’s backup
TotalRecycleBinFileCount Long
sets in recycle bin.

USERLOCKSETTINGS

KEY TYPE DESCRIPTIONS

LastFailureTime Long Time of last failure
LockedTime Long Time user has been locked
LoginFailureCount Integer Number of failed logins

USERSUSPENDSETTINGS

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
Date Long Timestamp in millisecond time format.

www.ahsay.com AhsayCBS API Guide | 245 of 450

WINDOWSEVENTLOGSETTINGS

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
LogProfile Boolean True / False
LogServices Boolean True / False
LogUtilities Boolean True / False
LogBackup Boolean True / False
LogError Boolean True / False
LogSoftwareUpdate Boolean True / False
LogReport Boolean True / False
LogLoginLogout Boolean True / False
LogInfo Boolean True / False
LogBuy Boolean True / False
LogLicense Boolean True / False
LogWarn Boolean True / False
LogRestore Boolean True / False

MODULEUSAGE

KEY TYPE DESCRIPTIONS

MSExMailbox Long Usage of MSExMailbox module license.
MSHyperVVM Long Usage of MSHyperVVM module license.
VMwareVM Long Usage of VMwareVM module license.
Office365Mail Long Usage of Office365Mail module license.
HostCount Long Usage of OBM / ACB license.

www.ahsay.com AhsayCBS API Guide | 246 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm2”
}
OUTPUT
{
“Status”:”OK”
“Data”:{
“Timezone”:”1098”,
“ClientRunVersion”:””,
“Owner”:””,
“HostCount”:1,
“SoftwareUpdateSettings”:{
“ReadOnly”:false,
“Enabled”:true,
“Id”:””
},
“ModuleSettings”:{
“MobileQuota”:0,
“VMwareVMQuotaTYpe”:”GUESTVM”,
“VMwareVMQuota”:0,
“MobileEnabled”:false,
“DeltaMergeEnabled”:false,
“MSExchangeMailboxBackupEnabled”:false,
“DeduplicationEnabled”:false,
“MariaDBBackupEnabled”:false,
“OracleBackupEnabled”:false,
“QnapEnabled”:false,
“MSExchaneBackupEnabled”:false,
“OpenDirectEnabled”:false,
“VMwareBackupEnabled”:false,
“InFileDeltaEnabled”:false,
“MSHyperVMQuota”:0,
“MySQLBackupEnabled”:false,
“MobileV2Quota”:0,
“LotusDominoBackupEnabled”:false,
“OpenDirectQuota”:0,
“MobileV2Enabled”:false,
“ReadOnly”:false,
“Office365MailQuota”:0,
“MSHyperVMQuotaType”:”GUESTVM”,
“NasClientENabled”:false,
“MSSQLBackupEnabled”:false,

www.ahsay.com AhsayCBS API Guide | 247 of 450

 “MSExchangeDAGServerQuota”:0,
“ShadowProtectBackupEnabled”:false,
“MSWindowsSystemStateBackupEnabled”:false,
“MSHyperVBackupENabled”:false,
“ShadowCopyEnabled”:false,
“LotusNotesBackupEnabled”:false,
“Id”:””,
“Office365MailEnabled”:false,
“CDPEnabled”:false,
“MSExMailboxQuota”:0,
“MSWindowsSystemBackupENabled”:false
},
“PasswordHistory”:{
“ReadOnly”:false,
“HistoryList”:[],
“PasswordLastModifiedTime”:1687069108460,
“Id”:””
},
“RunDirectQuotaEnabled”:false,
“Name”:”obm2”,
“AccessToken”:”E1C9029954184F92B858280B9A6A3EBAA4F8809CA3E441C198ED5
C2DE57918C3”,
“UserHome”:”C:\\Program Files\\AhsayCBS\\user\\obm2”,
“LastSuccessfulLoginInfo”:null,
“WindowsEventLogSettings”:{
“ReadOnly”:false,
“LogLoginLogout”:false,
“LogInfo”:false,
“LogLicense”:false,
“Enabled”:false,
“LogUtilities”:false,
“LogError”:false,
“LogServices”:false,
“Id”:””,
“LogSoftwareUpdate”:false,
“LogProfile”:false,
“LogRestore”:false,
“LogBackup”:false,
“LogWarn”:false,
“LogBuy”:false,
“LogReport”:false
},
“UserSuspendSettings”:{
“ReadOnly”:false,
“Enabled”:false,
“Id”:””,
“Date”:0
},

www.ahsay.com AhsayCBS API Guide | 248 of 450

 “Status”:ENABLE”,
“ReadOnly”:false,
“LockedbyMFA”:false,
“OpenDirectUsageCount”:0,
“EncodedName”:”obm2”,
“MobileUserID”:null,
“Updated”:false,
“SavePassword”:false,
“BackupSetIdList”:[],
“Hostname”:”jcvm.com”,
“MailboxUsage”:0,
“TrialDays”:2592000000,
“DoubleEncodedName”:”obm2”,
“LastClientLoginTime”:-1,
“PlanAmount”:-1,
“UploadEncryptionKey”:false,
“GroupPolicySettings”:{
“ReadOnly”:false,
“UserGroupIDList”:[
“1”
],
“ExcludeNetworkShare”:false,
“GroupQuota”:0,
“Id”:””,
“UserGroupQuota”:0,
“FileSizeLimit”:0
},
“YearPlan”:null,
“LastShowingLicViolationTime”:-1,
“Id”:”1687069108461”,
“RunDirectQuota”:1,
“File”:”C:\\Program Files\\AhsayCBS\\conf\\users.xml”,
“MobileAuthenticationSettings”:{
“Enable”:false,
“LastCountryCode”:””
},
“ForgotPasswordSettings”:{
“ReadOnly”:false,
“Token”:””,
“RequestTime”:-1,
“Id”:””
“ResetTime”:-1
},
“ForgotPasswordSettings”:{
“ReadOnly”:false,
“Token”:””,
“RequestTime”:-1,
“Id”:””,

www.ahsay.com AhsayCBS API Guide | 249 of 450

 “ResetTime”:-1
},
LdapSettings”:{
“ReadOnly”:false,
“LdapUser”:false,
“LastDeleteTime”:0,
“LastDisableTime”:0,
“Id”:””,
“FirstAuthFailuteTime”:-1
},
“TopDir”:”C:\\Program File\\AhsayCBS\\user”,
“EnableAUA”:true,
“ClientType”:OBM”,
“RegistrationDate”:1687069108460,
“QuotaList”:[
{
“DestinationKey”:OBS”,
“Quota”:5368091200,
“DestinationName”:AhsayCBS”,
“Enabled”:true
},
{
“DestinationKey”:”-1687068833705”,
“Quota”:0,
“DestinationName”:”Local-1”,
“Enabled”:false
},
{
“DestinationKey”:”-1686815201815”,
“Quota”:0,
“DestinationName”:”AhsayCBS-1”,
“Enabled”:false
}
],
“ProxySettings”:{
“ReadOnly”:false,
“Type”:””,
“Username”:””,
“Port”:””,
“Enabled”:false,
“Host”:””,
“Id”:””,
“Password”:””
},
“HostQuotaEnabled”:false,
“AdGroups”:[
1
],

www.ahsay.com AhsayCBS API Guide | 250 of 450

 “ComputerNameDirList”:null,
“SecuritySettings”:{
“UserLockSetings”:{
“LockedTime”:-1
“LastFailureTime”:-1,
“LoginFailureCount”:0
},
“PhoneList”:[],
“Enable”:false,
“SendLimitSettings”:{
“LastSendTime”:-1,
“SendCount”:0
},
“RecoverySettings”:{
“Token”:””,
“ExpiryTime”:-1
}
},
“AdGroup”:”1”,
“SuspendPaidUserDate”:”19700101”,
“MobileBackupSettings”:{
“DeviceList”:[]
},
“HostSet”:{
“”:””
},
“Locked”:false,
“CloudbackoGoDriveEnabled”:false,
“Language”:”en”,
“ServerSettings”:null,
“HomeDir”:”C:\\Program Files\\AhsayCBS\\user\obm2”,
“Bandwidth”:0,
“StorageQuota”:100,
“class”:”com.ahsay.obs.core.cxp.User”,
“HashedPassword”:true,
“SecurityIdentifier”:””,
“Notes”:””,
“Passowrd”:”BSJEajFurvvTdkh1V4+1Asgw6wjjIpkgK3rJ00y5S87B0=”,
“RemovingLogs”:null,
“NewBSetName”:”BackupSet-0”,
“ImportDate”:0,
“UserLockSettings”:{
“LockedTime”:-1,
“LastFailureTime”:-1,
“LoginFailureCount”:0
},
“TotalStatistics”:{
“TotalRecycleBinUncompressedSize”:0,

www.ahsay.com AhsayCBS API Guide | 251 of 450

 “DataAreaFileCount”:0,
“TotalRestoreCompressedSize”:0,
“TotalRecycleBiNFileCount”:0,
“LastBackupCOmpressedSize”:0,
“DataAreaCompressedSize”:0,
“LastBackupUncompressedSize”:0,
“RetentionAreaFileCount”:0,
“RetentionAreaUncompressedSize”:0,
“DataAreaUncompressedSize”:0,
“TotalUploadCOmpressedSize”:0,
“LastBackupFileCount”:0,
“TotalUploadFIleCOunt”:0,
“TotalRestoreFileCount”:0,
“TotalRecycleBinCompressedSize:0,
“RetentionAreaCompressedSize”:0
},
“QuotaTYpe”:”PER_DESTINTION_QUOTA”,
“V6File”:”C:\\Program Files\\AhsayCBS\\user\obm2\\db\\Profile.xml”,
“ROutineJobSettings”:{
“ReadOnly”:false,
“QuotaRemindPercentage”:0,
“Id”:””,
“InactiveReportLastSentTime”:-1
},
“LongLoginName”:”obm2”,
“ContactList”:[
{
“ReadOnly”:false,
“Company”:””,
“Phone1”:””,
“Email”:”[email protected]”,
“Address”:””,
“EmailCertificate”:””,
“Phone2”:””,
“EncryptEmail”:false,
“Website”:””,
“Id”:”1687069108462”,
“Name”:””
}
],
“EMailReportSettings”:{
“SendBkpRpt”:false,
“ReadOnly”:false,
“Usage”:0,
“Email”:””,
“ReportSenderEmail”:””,
“SmtpAuthUser”:””,
“Enabled”:false,

www.ahsay.com AhsayCBS API Guide | 252 of 450

 “SendBkpRptMode”:””,
“SmtpHostName”:””,
“MissedBkpInterval”:0,
“SmtpProtocol”:””,
“Id”:””,
“SmtpPort”:””,
“SendMissedBkpRpt”:false,
“SendStorageAlert”:false,
“SmtpAuthPwd”:””
},
“LastLoginTime”:0,
“Type”:”PAID”,
“UsedHostQuota”:0,
“Alias”:””,
“UserId”:”obm2”,
“FullName”:null,
“PreV7”:false,
“TrialExpiryDate”:0,
“MoveUserHomeRecord”:null,
“HostQuota”:1,
“HostInfo”:””
}
}

www.ahsay.com AhsayCBS API Guide | 253 of 450

MODIFYUSERSTATUS
This API can be used to modify a user account status to either enable or suspended. It cannot
be used for trial user accounts which are suspended after they have exceeded the trial period.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > User
Profile > General

URL
https://CBS.EXAMPLE.COM/obs/api/json/ModifyUserStatus.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of system user (if applicable)
Status String “ENABLE” or “SUSPENDED”

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 254 of 450

EXAMPLES

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm2”
“Status”:”SUSPENDED”
}
OUTPUT
{
“Status”:”OK”
}
OUTPUT 2 – User does not exist
{
“Status”:”Error”,
“Message”:”[UserCacheManager.NoSuchUserExpt] User ‘obm2’ not found.”,
“ExptType”:”com.ahsay.obs.core.dbs.ai”
}

www.ahsay.com AhsayCBS API Guide | 255 of 450

REMOVEUSER
This API removes a backup user.

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

Backup / Restore > Users, Groups & Policies > Backup User

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemoveUser.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of system user (if applicable)

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm2”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 256 of 450

SENDFORGOTPWDEMAIL
This API will send a forgot password email to a backup user who has forgot their login
password, to allow them to reset their login password.

URL
https://CBS.EXAMPLE.COM/obs/api/json/SendForgotPwdEmail.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of system user (if applicable)

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 257 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2 – LOGIN NAME IS INCORRECT / DOES NOT EXIST

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm2”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[UserCacheManager.NoSuchUserExpt] User ‘obm2’ not found.”,
“ExptType”:”com.ahsay.obs.core.dbs.ai”
}

www.ahsay.com AhsayCBS API Guide | 258 of 450

GETUSERSTATUS
This API can be used to retrieve detailed information of backup or restore jobs that are
currently running.

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

Monitoring > Live Activities > Backup User > Backup Status OR Restore Status

URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetUserStatus.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
Type String The value can be one of the following:
backup
restore

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
BkpStatus Array of If input parameter type is “backup”,
BkpStatus array of BkpStatus is returned.
RestoreStatus Array of If input parameter type is “restore”,
RestoreStatus array of RestoreStatus is returned.
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 259 of 450

JSON OBJECTS

BKPSTATUS / RESTORESTATUS

KEY TYPE DESCRIPTIONS

ID String ID of Backup and Restore job status
LoginName String Name of the backup account.
Owner String Owner of the backup account.
UserId String ID of the backup account.
Alias String Alias of the backup account.
UserType String User type.
The value can be one of the following:
Trial
Paid
ClientType String Backup client type.
The value can be one of the following:
OBM
ACB
Type String Backup set type.
The value can be one of the following:
FILE
Cloud File
Lotus Domino
Lotus Notes
Microsoft Exchange Server
Microsoft Exchange Mail (MAPI)
Microsoft SQL Server
Microsoft Windows Virtualization
Microsoft Windows System Backup
MySQL
Oracle Database Server
ShadowProtect Bare Metal
System State
VMware Virtualization
Office 365 Exchange Online
BackupSet String Name of the backup set.
BackupSetID String ID of the backup set.
DestinationID String ID of the backup destination.
DestinationName String Name of the backup destination.
DestinationType String Destination storage of the backup set.

www.ahsay.com AhsayCBS API Guide | 260 of 450

 The value can be one of the following:
Local / Mapped Drive / Removable
Drive : Local
Alibaba Cloud : Aliyun
CTYun : CTYun
Amazon S3 : S3
AWS S3 Compatible Cloud Storage :
AWSCompatible
Wasabi
Backblaze
Google Cloud Storage : GCS
Google Drive : GDrive
Microsoft Azure : Azure
OneDrive : OneDrive
OneDrive for Business :
OneDrive4Biz
Rackspace : Rackspace
OpenStack : OpenStack
Dropbox : Dropbox
FTP : FTP
SFTP : SFTP
AhsayCBS : OBS
Destination pool : Pooled
For backup job with version 6 backup
client: %EMPTY%
OverallPercent String Progress of the backup job shown in
percentage.
BackupStatus String Message type of the current stage of the
backup job. (Info/Warn/Error).
LastMessage String Last message reported during the backup
job.
LastUpdateTime String Time of the last message reported during
the backup job.
EstimatedTimeLeft String Estimated time to backup job
completion.
SizeLeft String Data size left to be backed up.
UploadedSize String Data size of all uploaded data during the
backup job.
TransferRate String Transfer rate measured at the moment.
CurrentFile String Current backup / restore file.
UploadedNumOfFiles String Total number of files uploaded for

www.ahsay.com AhsayCBS API Guide | 261 of 450

 BackupStatus (e.g. input Type":"backup")
or Total number of files downloaded for
RestoreStatus (e.g. input
“Type":"restore").
UploadedNumOfDirs String Total number of directories uploaded for
BackupStatus (e.g. input Type":"backup")
Or Total number of directories
downloaded for RestoreStatus (e.g. input
"Type":"restore").
UploadedNumOfLinks String Total number of links uploaded for
BackupStatus (e.g. input Type":"backup")
Or Total number of links downloaded for
RestoreStatus (e.g. input
"Type":"restore").
ElapsedTime String Elapsed time of the backup job.
CurrentFilePercent String Upload percentage of the current file
being backed up / restored.
CurrentFileType String Current type.
The value can be one of the following:
Full
Incremental
Differential
CurrentFileOperation String File operation list.
The value can be one of the following:
new
update
delete
move
file permission
DeltaFile String Delta file path.
DeltaFilePercent String Upload percentage of the current delta
file.
DeltaType String Delta type.
The value can be one of the following:
Incremental
Differential
BackupJobID or String Backup Job ID for BackupStatus (e.g.
RestoreJobID input "Type":"backup"), or Restore Job ID
for RestoreStatus (e.g. input
"Type":"restore").
ID in YYYY-MM-DD-hh-mm-ss format.

www.ahsay.com AhsayCBS API Guide | 262 of 450

EXAMPLES

EXAMPLE 1 – If “Type” is “backup” (“Type”:”backup”)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”backup”
}
OUTPUT
{
“Status”:”OK”,
“BkpStatus”:[
{
“LoginName”:”obm”,
“Owner”:””,
“ClientType”:”OBM”,
“CurrentFileType”:””,
“UploadedNumofLinks”:”0”,
“ElapsedTime”:”4 sec”,
“BackupSetID”:”1687077919738”,
“DestinationType”:”OBS”,
“CurrentFile”:””,
“TransferRate”:”0bit/s”,
“LastMessage”:”[1687077949198] Using Temporary Directory
C:\\Users\’user’\\.obm\\temp\\1687077919738\\OBS@1687077949198”,
“UploadedSize”:”0”,
“LastUpdateTime”:”06/18/2023 16:46:03”,
“EstimatedTimeLeft”:”0 sec”,
“DestinationName”:”AhsayCBS”,
“BackupSet”:”Backup Set Test (File Backup)”,
“SizeLeft”:”0”,
“ID”:”0”,
“DeltaFilePercent”:”0”,
“DeltaType”:””,
“UploadedNumOfFiles”:”0”,
“CurrentFileOperation”:””,
“BackupJobID”:”2023-06-18-16-45-58”,
“DestinationID”:”1687077949198”,
“OverallPercent”:”0”,
“Type”:”FILE”,
“CurrentFilePercent”:”0”,
“UserId”:”1686791459557”,
“Alias”:”obm”,
“DeltaFile”:””,
“UploadedNumOfDires”:”0”,

www.ahsay.com AhsayCBS API Guide | 263 of 450

 “UserType”:”PAID”,
“BackupStatus”:”info”
}
}

EXAMPLE 2 – If “Type” is “restore” (“Type”:”restore”)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”backup”
}
OUTPUT
{
“Status”:”OK”,
“RestoreStatus”:[
{
“LoginName”:”obm”,
“Owner”:””,
“ClientType”:”OBM”,
“CurrentFileType”:””,
“UploadedNumOfLinks”:”0”,
“ElapsedTime”:”0 sec”,
“BackupSetID”:”1687077919738”,
“DestinationType”:”OBS”,
“CurrentFile”:””,
“TransferRate”:”0bit/s”,
“LastMessage”:”start,Start [ AhsayOBM v9.5.4.0 ],0,0,0,,0,0\r\n”,
“UploadedSize”:”0”,
“LastUpdateTime”:”06/18/2023 16:58:28”,
“EstimatedTImeLeft”:”0 sec”,
“DestinationName”:”AhsayCBS”,
“BackupSet”:”Backup Set Test (File Backup)”,
“SizeLeft”:”0”,
“ID”:”0”,
“DeltaFilePercent”:”0”,
“ExecuteJob”:””,
“RestoreJobID”:”2023-06-18-16-58-28”,
“DeltaType”:””,
“UploadedNumOfFiles”:”0”,
“CurrentFileOperation”:””,
“DestinationID”:”1687077949198”,
“OverallPercent”:”0”,
“Type”:”FILE”,
“CurrentFilePercent”:””,

www.ahsay.com AhsayCBS API Guide | 264 of 450

 “UserId”:”1686791459557”,
“Alias”:”obm”,
“DeltaFile”:””,
“UploadedNumOfDires”:”0”,
“UserType”:”PAID”,
“BackupStatus”:”info”
}
]
}

www.ahsay.com AhsayCBS API Guide | 265 of 450

GETSERVERRUNJOBSTATUS
This API can be used to retrieve detailed information of Run-on-Server (agentless) backup or
restore jobs that are currently running.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> Execute Job

URL
https://CBS.EXAMPLE.COM/cbs/api/json/GetServerRunJobStatus.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
User String Username of the user to lookup.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
RunJob Array of RunJob Run-on-Server (agentless) backup set
status (backup, restore,
dataIntegrityCheck, deleteBackupData).

www.ahsay.com AhsayCBS API Guide | 266 of 450

JSON OBJECTS

RUNJOB

KEY TYPE DESCRIPTIONS

IsEnableStopBtn Boolean True for manually run jobs, and False
when it is a scheduled job or job where
there is no Stop in the UI.
BackupSetID String Backup set ID.
ExecuteJob String Job currently running, empty if no
running job.

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“User”:”obm”
}
OUTPUT
{
“Status”:”OK”,
“RunJob”:[
{
“BackupSetID”:”1687077919738”,
“ExecuteJob”:””
}
]
}

www.ahsay.com AhsayCBS API Guide | 267 of 450

UPDATEAUA
This API can be used to toggle a list of Backup User(s) Auto Update Agent (AUA) setting.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Click “Auto
Update” > mark / unmark > Click “Auto Update” or “Cancel Auto Update” button

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateAUA.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
Enabled Boolean Set the list of users to enable / disable
Auto Update.
UerIdList String Multiple login names (case sensitive),
separated by commas.
For example: user1, user2, uSEr3

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 268 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Enabled”:false,
“UserIdList”:”user1, user2”
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“UserIdList”:”user1, user2”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Parameter Enabled is null / empty!”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 269 of 450

EXAMPLE 3

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Enabled”:true,
“UserIdList”:”obm2”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[UserCacheManager.NoSuchUserExpt] User ‘obm2’ not found.”
“ExptType”:”com.ahsay.obs.core.dbs.ai”
}

www.ahsay.com AhsayCBS API Guide | 270 of 450

3.2 BACKUP SET

UPDATEBACKUPSET (V1, V2)

This API can be used to update settings of a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name%

NOTE
Ahsay v9 introduces Deduplication. For users running v9 client, new backup sets created from v9 will not use
In-File Delta, but rather use Deduplication; adjust your API call accordingly.

V1 UPDATEBACKUPSET.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateBackupSet.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 UPDATEBACKUPSET.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/UpdateBckupSet.do
AVAILABLE SINCE VERSION:
9.5.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
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.
BackupSetID String Obtainable by calling the ListBackupsets
API.
RecycleBinSettings JSON Object See RecycleBinSettings
ReadOnly Boolean True / False

www.ahsay.com AhsayCBS API Guide | 271 of 450

Class String com.ahsay.obx.cxp.obs.BackupSet
Name String Backup set name.
ShadowCopyEnabled Boolean Enable Windows' Volume Shadow Copy
for open file backup.
DeleteTempFile String Remove temporary files after backup.
LogRetentionDays Integer Number of days to keep the backup set
log.
FollowLink Boolean Follow link of the backup files.
CompressType String The value can be one of the following:
"GzipBestSpeedCompression"
(Fast),
"GzipDefaultCompression"
(Normal),
"SnappyDefaultCompression "
(Optimal for local)
Default to ‘No Compression' if not
provided
LanDomain String Windows User Authentication
domain/host name.
LanUsername String Windows User Authentication user
name.
LanPassword String Windows User Authentication user
password.
WorkingDir String Temporary Driectory for storing backup
files.
UploadPermission Boolean Enable to backup permission attribute of
files.
ReminderSettings Array Array of Reminder settings.
InFileDeltaSettings Array Array list of InFile Delta settings
LocalCopySettings Array Array list of Local Copy settings
RetentionPolicySettings Array Array list of Retention Policy settings
CdpSettingsV6 Array Array list of Cdp setting for v6
CdpSettingsV7 Array Array list of Cdp settings for v7
BandwidthControlSettings Array Array list of Bandwidth Control settings
FilterSettings Array Array list of Filter settings
ScheduleSettings Array Array list of Schedule settings
DestinationSettings Array Array list of Destination settings
SelectedSourceList Array Can be an array with local path (String
type) and network address with

www.ahsay.com AhsayCBS API Guide | 272 of 450

 credential (NetworkAddress type).
DeselectedSourceList Array Can be an array with local path (String
type) and network address with
credential (NetworkAddress type).
PreCommandList Array Array list of pre commands
PostCommandList Array Array list of post commands
AllowedIPList Array Array list of allows IPs for restore
ApplicationSettings Array Array list of Application settings
DestinationList Array Array list of Destinations(optional)
EnableOpenDirect Boolean Note: Cannot be changed once set
NetworkAddress JSON Object Can be used in SelectedSourceList and
DeselectedSourceList.
DeduplicationSettings Object Refer to DeduplicationSettings.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

REMINDERSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
BackupIntervalHours Integer 00-23
OfflineNotificationDay Integer This settings only applicable for v6 legacy
backup users.
OfflineBackupEnabled Boolean On-Off for offline backup reminder.
BackupIntervalDay Integer 00-31
ShowOfflineBackupReminder Boolean This setting only applicable for v6 legacy
backup users.
LogoutBackupReminderEnabled Boolean Enable/Disable backup reminder when
windows log off or shut down.

www.ahsay.com AhsayCBS API Guide | 273 of 450

 OfflineBackupReminderComputerName String The computer name for the offline
backup reminder.
LogoutBackupReminderComputerName String The computer name for logout backup
reminder.

INFILEDELTASETTINGS

KEY TYPE DESCRIPTIONS

Enabled Boolean True / False
ReadOnly Boolean True / False
MinDeltaFileSize Long Only apply In-File Delta to files larger
than this size.
MaxNumOfDelta Long Upload full file when number of deltas
are over this number.
Highly recommended to choose one of
the following value:
10
20
30
50
100
MaxDeltaRatio Long Upload full file when delta file size / full
file size is over this ratio.
It can only be multiple of 5 of maximum
100.
DefaultDeltaType String The value can be one of the following:
I
D
WeeklyInFileDeltaSchedule Array Weekly variations for overriding default
type.
MonthlyInFileDeltaSchedule Array Yearly variations for overriding default
type and weekly variations.

www.ahsay.com AhsayCBS API Guide | 274 of 450

WEEKLYINFILEDELTASCHEDULE

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Day Array The array contains 7 Strings, which
corresponds to the delta type from
Sunday to Saturday.
“I” for inrecemental delta on that day,
“D” for differential delta on that day, and
“” for full backup on that day.

MONTHLYINFILEDELTASCHEDULE

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Month Array The array contains 12 Strings, which
corresponds to the delta type from
January to December.
"I" for incremental delta on that month,
"D" for differential delta on that month,
and "" for full backup on that month.
Date Integer Day of selected months in yearly
variations.
Criteria String The value can be one of the following:
Weekday
Weekend
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Occurrence String The value can be one of the following:
First
Second
Third
Fourth
Last

www.ahsay.com AhsayCBS API Guide | 275 of 450

LOCALCOPYSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Enabled Boolean This setting only applicable for v6 legacy
backup users.
DestinationPath String This setting only applicable for v6 legacy
backup users.
SetPermission Boolean This setting only applicable for v6 legacy
backup users.
SkipOffsiteBackup Boolean This setting only applicable for v6 legacy
backup users.
LocalCopyRetentionPolicySettings Array This setting only applicable for v6 legacy
backup users.
Zip Boolean This setting only applicable for v6 legacy
backup users.

LOCALCOPYRETENTIONPOLICYSETTING

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Enabled Boolean This setting only applicable for v6 legacy
backup users.
Period Integer This setting only applicable for v6 legacy
backup users.
Unit String This setting only applicable for v6 legacy
backup users.
The value can be one of the following:
DAYS
JOBS

www.ahsay.com AhsayCBS API Guide | 276 of 450

RETENTIONPOLICYSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Period Integer Keep the deleted files for this number of
days.
OverlapSensitive Boolean True / False
Type String The value can be one of the following:
SIMPLE
ADVANCED
Unit String The value can be one of the following:
DAYS
JOBS
AdvancedRetentionPolicyList Array Array list of Advanced Retention Policies

ADVANCEDRETENTIONPOLICY

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Id Long ID of the retention policy to update.
Type String The value can be one of the following:
DAILY
WEEKLY
MONTHLY
QUARTERLY
YEARLY
CUSTOM
NumbersToKeep Integer Available to change when you choose the
following type:
DAILY
WEEKLY
MONTHLY
QUARTERLY
YEARLY
Day Integer Available to change when you choose the
following type:
DAILY
WEEKLY
MONTHLY

www.ahsay.com AhsayCBS API Guide | 277 of 450

 QUARTERLY
YEARLY
Week Integer Available to change when you choose the
following type:
DAILY
WEEKLY
MONTHLY
QUARTERLY
YEARLY
Month Integer Available to change when you choose the
following type:
DAILY
WEEKLY
MONTHLY
QUARTERLY
YEARLY
Year Integer Available to change when you choose the
following type: CUSTOM.
DateType String It can be empty for daily or weekly
retention policy, or one of the following:
WEEK_OF_MONTH
WEEK_OF_YEAR
EXACT
Sun, Mon, Tue, Wed, Thu, Fri, Sat Boolean For weekly custom retention policy.

www.ahsay.com AhsayCBS API Guide | 278 of 450

CDPSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Enable Boolean True / False
Type String For CdpSettingsV6, the value can be one
of the following:
all-volume
backup-source
custom-source
For CdpSettingsV7, the value is
all-volume
BackupType String The value can be empty, or one of the
following:
DATABASE
DIFFERENTIAL
LOG
SKIP
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
MinUpdateInterval Integer Update Intervals
TimeMarkInterval Integer Mark intervals
MaxFileSize Integer Only apply to files smaller than:
20
50
100

www.ahsay.com AhsayCBS API Guide | 279 of 450

 500
1000
unlimited
ComputerName String Run CDP on computers named.
ExcludeSystemFiles Boolean True / False
FilterList Array Array list of Filters
Version String For CdpSettingsV7, the value is 7.
CdpBackupControlSettings Array This setting only applicable for v6 legacy
backup users.
SelectedSourceList Array Array list of selected sources
Id Array V6 for CdpSettingV6 / v7 for
CdpSettingV7.

CDPBACKUPCONTROLSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
ConsiderCpuUsage Boolean This setting only applicable for v6 legacy
backup users.
CpuUsage Integer This setting only applicable for v6 legacy
backup users.
ConsiderInput Boolean This setting only applicable for v6 legacy
backup users.
ObserveInputForSecond Integer This setting only applicable for v6 legacy
backup users.
ConsiderNetworkTraffic Boolean This setting only applicable for v6 legacy
backup users.
NetworkTraffic Long This setting only applicable for v6 legacy
backup users.

BANDWIDTHCONTROLSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Enabled Boolean True / False
BandwidthControlList Array Array list of Bandiwdth Controls
Mode String The value can be one of the following:
independent
share

www.ahsay.com AhsayCBS API Guide | 280 of 450

BANDWIDTHCONTROL

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of control setting
Id Long ID of control setting
MaxTransferRateInBitsPerSec Long Maximum allowable transfer rate
StartDay Integer Starting day of control
StartHour Integer Starting hour of control
StartMinute Integer Starting minute of control
EndDay Integer Ending day of control
EndHour Integer Ending hour of control
EndMinute Integer Ending minute of control

FILTERSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Enabled Boolean True / False
FilterList Array Array list of filters

FILTERLIST

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of the filter
Id Long Id of the filter, obtainable in
GetBackupSet API.
TopDir String Apply filter to a specific directory only.
@class String com.ahsay.obx.cxp.obs.Filter
ApplyToDir Boolean Apply filters to directory.
Type String The value can be one of the following:
START_WITH
END_WITH
CONTAIN
CUSTOM
Include Boolean For each of the matched files/folders

www.ahsay.com AhsayCBS API Guide | 281 of 450

 under top directory:
Exclude or include them
Only Boolean If it is set to true, it will not include all
unmatched files/folders.
If it is set to false, it will include all
unmatched files/folders.
PatternList Array Array list of patterns
MatchPatternAgainstFullPathOnly Boolean True / False
Username String Support UNC paths with non-Windows
credentials as backup source.
Password String Support UNC paths with non-Windows
credentials as backup source.

PATTERN

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Pattern String Details of pattern

APPLICATIONSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
@class String The value can be one of the following:
com.ahsay.obx.cxp.cloud.FileSettings
com.ahsay.obx.cxp.cloud.LotusDominoSettings
com.ahsay.obx.cxp.cloud.LotusNotesSettings
com.ahsay.obx.cxp.cloud.MSExchangeSettings
com.ahsay.obx.cxp.cloud.MSExMailboxSettings
com.ahsay.obx.cxp.cloud.MSSQLSettings
com.ahsay.obx.cxp.cloud.MSHypervSettings
com.ahsay.obx.cxp.cloud.MSWindowsSystemSettings
com.ahsay.obx.cxp.cloud.MySQLSettings
com.ahsay.obx.cxp.cloud.OracleSettings
com.ahsay.obx.cxp.cloud.ShadowProtectSettings
com.ahsay.obx.cxp.cloud.MSWindowsSystemStateSettings
com.ahsay.obx.cxp.cloud.VMwareSettings
com.ahsay.obx.cxp.cloud.Office365ExchangeOnlineSettings
com.ahsay.obx.cxp.cloud.CloudFileSettings

www.ahsay.com AhsayCBS API Guide | 282 of 450

 com.ahsay.obx.cxp.cloud.MariaDBSettings
com.ahsay.obx.cxp.cloud.TiberoSettings
com.ahsay.obx.cxp.cloud.LinuxBareMetalSettings
Id String ID of application setting
Version String Version of application setting
WindowsOutlook Boolean Backup source shortcut to Outlook.
Applicable for File backup set only.
WindowsDesktop Boolean Backup source shortcut to Desktop.
Applicable for File backup set only.
WindowsOutlookExpress Boolean Backup source shortcut for Outlook Express.
Applicable for File backup set only.
WindowsMail Boolean Backup source shortcut to Windows Mail.
Applicable for File backup set only.
WindowsFavourites Boolean Backup source shortcut to Favourites.
Applicable for File backup set only.
WindowsMyDocuments Boolean Backup source shortcut to My Document.
Applicable for File backup set only.
NotesIniPath String Path to notes.ini.
Applicable for IBM Lotus Domino / IBM Lotus Notes backup
set only.
BackupSystemState Boolean Applicable for MS Exchange Server backup set only.
LoginID String Login ID of sa / system account.
Applicable for MS SQL Server / Oracle Database Server
backup set only.
Password String Password of sa / system / root account.
Applicable for MS SQL Server / MySQL / Oracle / MariaDB
Database Server / VMware backup set only.
Server String SQL Server instance.
Applicable for MS SQL Server backup set only.
BackupTarget String Temporary storage location of the MS Windows System /
System State backup set.
Applicable for MS Windows System / System State backup
set only.
Port Integer Listening port of the MySQL / Oracle Database Server
Port to the VMware hypervisor.
Applicable for MySQL / Oracle / MariaDB Database Server /
VMware backup set only.
Host String Hostname or IP to the MySQL / Oracle / MariaDB Database
Server, or VMware hypervisor.
Applicable for MySQL / Oracle / MariaDB Database Server /

www.ahsay.com AhsayCBS API Guide | 283 of 450

 VMware backup set only.
Username String Username of root account.
Applicable for MySQL / VMware / MariaDB backup set
only.
MysqldumpPath String Applicable for MySQL / MariaDB backup set only.
LastArchivedLogName String Applicable for Oracle Database Server backup set only.
Sid String Oracle SID.
Applicable for Oracle Database Server backup set only.
EncryptionAlgorithm String Applicable for ShadowProtect System backup set only.
EncryptionPassword String Applicable for ShadowProtect System backup set only.
InstallLocation String Applicable for ShadowProtect System backup set only.
Sshport Integer Applicable for VMware backup set only.
AutoEnableCBT Boolean Applicable for VMware backup set only.
OneDrive Boolean Applicable for Microsoft 365 backup set only.
PublicFolders Boolean Applicable for Microsoft 365 backup set only.
SiteCollections Boolean Applicable for Microsoft 365 backup set only.
Outlook Boolean Applicable for Microsoft 365 backup set only.

SCHEDULESETTING

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Enable Boolean True / False
ComputerName String Name of computer
DailyScheduleList Array Array list of Daily Schedules
WeeklyScheduleList Array Array list of Wekely Schedules
MonthlyScheduleList Array Array list of Monthly Schedules
CustomScheduleList Array Array list of Custom Schedules

www.ahsay.com AhsayCBS API Guide | 284 of 450

DAILYSCHEDULELIST

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of the schedule.
Id Long ID of the schedule, obtainable in
GetbackupSets API.
Hour Integer Refer to HH.
The schedule will start backup at HH:MM
Minute Integer Refer to MM.
The schedule will start backup at 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
stop backup after xx hours = 1 to 24
BackupType String The value can be empty, or one of the
following:
DATABASE
DIFFERENTIAL
LOG
SKIP
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 from backup
destination according to retention policy.

www.ahsay.com AhsayCBS API Guide | 285 of 450

LastUpdateTime Long
@class String com.ahsay.obx.cxp.obs.DailySchedule
MigratedFromCdp Boolean True indicate it is migrated from CDP,
this value cannot be changed.
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, 720
(-1 means periodic schedule is disabled
that it is a normal schedule.)

WEEKLYSCHEDULELIST

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of the schedule.
Id Long Id of the schedule, obtainable in
GetBackupSet API.
Hour Integer Refer to HH.
The schedule will start backup at HH:MM
Minute Integer Refer to MM.
The schedule will start backup at 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
stop backup after xx hours = 1 to 24
BackupType String Refer to "BackupType" of DailySchedule.
Days Array The array contains 7 boolean values that
correspond to Sunday to Saturday.
If the boolean value is true, backup will
be run on that day.
SpaceFreeUpEnabled Boolean Remove obsolete files according to
retention policy from backup destination
according to retention policy.
LastUpdateTime Long Time of last update
@class String com.ahsay.obx.cxp.obs.WeeklySchedule

www.ahsay.com AhsayCBS API Guide | 286 of 450

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, 720
(-1 means periodic schedule is disabled
that it is a normal schedule.)

MONTHLYSCHEDULELIST

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of schedule
Id Long Id of the schedule, obtainable in
GetBackupSet API.
Hour Integer Refer to HH.
The schedule will start backup at
HH:MM.
Minute Integer Refer to MM.
The schedule will start backup at
HH:MM.
BackupType String Refer to "BackupType" of DailySchedule.
Duration Integer Length of time
Occurrence String The value can be one of the following:
First
Second
Third
Fourth
Last
Criteria String The value can be one of the following:
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Weekday
Weekend

www.ahsay.com AhsayCBS API Guide | 287 of 450

SpaceFreeUpEnabled Boolean Remove obsolete files according to
retention policy from backup destination
according to retention policy.
LastUpdateTime Long Time of last update
@class String com.ahsay.obx.cxp.obs.MonthlySchedule

CUSTOMSCHEDULELIST

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of the schedule
Id Long ID of the schedule, obtainable in
GetBackupset API.
Hour Integer Refer to HH.
The schedule will start backup at
HH:MM.
Minute Integer Refer to MM.
The schedule will start backup at
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
stop backup after xx hours = 1 to 24
Date String In yyyy-MM-dd format.
Backup on this day once.
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 Time of last update
@class String com.ahsay.obx.cxp.obs.CustomSchedule

www.ahsay.com AhsayCBS API Guide | 288 of 450

COMMAND

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Name String Name of command
Command String Specifics of command
Type String The value can be one of the following:
Pre
Post
Id Long Id of the command, obtainable in
GetBackupSet API.
WorkingDir String Directory
Username String Support UNC paths with non-Windows
credentials as backup source.
Password String Support UNC paths with non-Windows
credentials as backup source.

ALLOWEDIP

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Id Long Id of the command, obtainable in
GetBackupSet API.
StartIP String Starting value of allowable IPs
EndIP String Ending value of allowable IPs

DESTINATIONSETTINGS

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
DestinationList Array Array list of Destinations

DESTINATION

KEY TYPE DESCRIPTIONS

ReadOnly Boolean True / False
Id Long Id of the destination, obtainable in GetBackupSet API.
Name String Name of Destination

www.ahsay.com AhsayCBS API Guide | 289 of 450

TopDir String Top Directory
@class String The value can be one of the following:
com.ahsay.obx.cxp.obs.LocalDestination
com.ahsay.obx.cxp.obs.AmazonS3Destination
com.ahsay.obx.cxp.obs.AWSCompatibleDestination
com.ahsay.obx.cxp.obs.GoogleCloudStorageDestination
com.ahsay.obx.cxp.obs.GoogleDriveDestination
com.ahsay.obx.cxp.obs.WindowsAzureDestination
com.ahsay.obx.cxp.obs.OneDriveDestination
com.ahsay.obx.cxp.obs.OpenStackDestination
com.ahsay.obx.cxp.obs.RackspaceDestination
com.ahsay.obx.cxp.obs.DropboxDestination
com.ahsay.obx.cxp.obs.FtpDestination
com.ahsay.obx.cxp.obs.SftpDestination
com.ahsay.obx.cxp.obs.ObsDestination
com.ahsay.obx.cxp.obs.PooledDestination
com.ahsay.obx.cxp.obs.AliyunDestination
com.ahsay.obx.cxp.obs.BackblazeDestination
com.ahsay.obx.cxp.obs.WasabiDestination
Type String The value can be one of the following:
Local
CloudDrive
S3
AWSCompatible
Wasabi
Backblaze
GCS
GDrive
Azure
OneDrive
OpenStack
Rackspace
Dropbox
FTP
SFTP
OBS
Pooled
Aliyun
Exchange
UserName String Username used to log in to Destination
Password String Password used to log in to Destination

www.ahsay.com AhsayCBS API Guide | 290 of 450

HostName String Hostname or IP of Destination
Port String Port used by Destination
AccessKey String AccessKey used by Destination
Location String Location used by Destination
DestinationKey String Destination Key used by Destination
Secret String Secret used by Destination
UserID String UserID used by Destination
Token String Token used by Destination
ClientId String ClientID used by Destination
UserDisplayName String User Display Name as shown by Destination
ClientSecret String Client Secret of the Destination
Region String Region of the Destination
TenantID String TenantID of the Destination
AppFolderName String Application Folder Name of the Destination
UsingSSL Boolean True / False
UsingProxy Boolean True / False
DestinationList Array Array list of Destinations

NETWORKADDRESS

KEY TYPE DESCRIPTIONS

Src String Source
Username String Username used to login
Password String Password used to login

RECYCLEBINSETTINGS

KEY TYPE DESCRIPTIONS

Enabled 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.
Id String Not used

www.ahsay.com AhsayCBS API Guide | 291 of 450

DEDUPLICATIONSETTINGS

KEY TYPE DESCRIPTIONS

Enabled Boolean Whether deduplication is enabled.
Scope String Either SAME_FILE or ALL_FILES, other
value 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 – 4 M
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
backup.
Id String Unused

NOTE
The OpenDirect setting (EnbleOpenDirect) cannot be changed once it was enabled when creating a
backupset. Create a new backup set if you need to disable OpenDirect for your backup set.

www.ahsay.com AhsayCBS API Guide | 292 of 450

EXAMPLES

EXAMPLE 1 – UPDATING A MICROSOFT 365 ONLINE DESTINATION

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“ApplicationSettings”:{
“@class”:”com.ahsay.obx.cxp.cloud.Office365ExchangeOnlineSettings”,
“RunOnServer”:false,
“Destination”:{

“@class”:”com.ahsay.obx.cxp.obs.Office365ExchangeOnlineDestination”,
“Type”:”Exchange”,
“Password”:””,
“DataMigrationMappingMergedToIndex”:false,
“MultiAccounts”:true,
“UserName”:”[email protected]”,
“DestinationKey”:”OBS”,
“Id”:”-1686815201815”
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2 – UPDATING A CBS DESTINATION

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687138324430”,
“DestinationSettings”:{
“DestinationList”:[
{
“Name”:”CBS”,
“@class”:”com.ahsay.obx.cxp.obs.ObsDestination”:,
“Type”:”OBS”
}
]
}
}

www.ahsay.com AhsayCBS API Guide | 293 of 450

 OUTPUT
{
“Status”:”OK”
}

EXAMPLE 3 – UPDATING A WEEKLY IN-FILE DELTA SETTING (V8 LEGACY BACKUP SET)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“InFileDeltaSettings”:{
“Enabled”:true,
“MinDeltaFileSize”:”30”,
“MaxNumOfDelta”:”200”,
“MaxDeltaRatio”:”55”,
“DefaultDeltaType”:”I”,
“WeeklyInFileDeltaSchedule”:{
“Day”:[“I”,”D”,”I”,”D”,”I”,”D”,”I”]
} }
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 4 – UPDATING A MONTHLY IN-FILE DELTA SETTING (V8 LEGACY BACKUP SET)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“InFileDeltaSettings”:{
“Enabled”:true,
“MinDeltaFileSize”:”30”,
“MaxNumOfDelta”:”200”,
“MaxDeltaRatio”:”55”,
“DefaultDeltaType”:”I”,
“MonthlyInFileDeltaSchedule”:{
“Month”:[“D”,”I”,”D”,”I”,”D”,”I”,”D”,”I”,”D”,”I”,”D”,”I”,”D”],
“Date”:”3”
}

www.ahsay.com AhsayCBS API Guide | 294 of 450

 }
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 5 – RECYCLE BIN SETUP

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”ACB”,
“BackupSetID”:”1692320086130”,
“RecycleBinSettings”:{
“Enabled”:true,
“RetentionPeriod”:10
}
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 6 – UPDATING A SIMPLE RETENTION POLICY

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“RetentionPolicySettings”:{
“Period”:”3”,
“Type”:”SIMPLE”,
“Unit”:”JOBS”
}
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 295 of 450

EXAMPLE 7 – UPDATING AN ADVANCED DAILY RETENTION POLICY

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“RetentionPolicySettings”:{
“Type”:”ADVANCED”,
“AdvancedRetentionPolicyList”:[
{
“Id”:”1687139082362”,
“Type”:”DAILY”,
“NumbersToKeep”:”3”
}
]
}
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 8 – UPDATING AN ADVANCED WEEKLY RETENTION POLICY

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“RetentionPolicySettings”:{
“Period”:”3”,
“Type”:”ADVANCED”,
“Unit”:”JOBS”,
“AdvancedRetentionPolicyList”:[
{
“Id”:”168713082362”,
“Type”:”WEEKLY”,
“NumbersToKeep”:”3”,
“Mon”:”true”
}
]
}

www.ahsay.com AhsayCBS API Guide | 296 of 450

}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 9 – UPDATING AN ADVANCED MONTHLY RETENTION POLICY

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“RetentionPolicySettings”:{
“Type”:”ADVANCED”,
“AdvancedRetentionPolicyList”:[
{
“Id”:”1687139082362”,
“Type”:”MONTHLY”,
“Day”:”12”,
“NumbersToKeep”:”3”
}
]
}
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 10 – UPDATING AN ADVANCED CUSTOM RETENTION POLICY

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“RetentionPolicySettings”:{
“Type”:”ADVANCED”,
“AdvancedRetentionPolicyList”:[
{

www.ahsay.com AhsayCBS API Guide | 297 of 450

 “Id”:”1687139082362”,
“Type”:”CUSTOM”,
“Month”:6,
“Day”:31,
“Year”:2023
}
]
}
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 11 – UPDATING A BANDWIDTH CONTROL SETTING

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“BandwidthControlSettings”:{
“Enabled”:true,
“Mode”:”Share”,
“BandwidthControlList”:[
{
“Name”:”ban1”,
“Id”:”1687139082362”,
“MaxTransferRateInBitsPerSec”:”25600000”
}
]
}
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 298 of 450

EXAMPLE 12 – UPDATING A FILTER SETTING

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“FilterSettings”:{
“Enabled”:true,
“FilterList”:[
{
“Name”:”update”,
“@class”:”com.ahsay.obx.cxp.obs.Filter”,
“Id”:”1687142103157”,
“TopDir”:”C:\\test”,
“ApplyToDir”:”false”,
“PatternList”:[
{
“Pattern”:”.txt”
},
{
“Pattern”:”.png”
}
]
}
]
}
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 13 – UPDATING A DAILY SCHEDULE AND CUSTOM SCHEDULE SETTINGS

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“ScheduleSettings”:{
“Enable”:true,
“DailyScheduleList”:[
{

www.ahsay.com AhsayCBS API Guide | 299 of 450

 “Id”:”1434946034621”,
“Hour”:”12”,
“Minute”:”30”
}
],
“CustomScheduleList”:[
{
“Id”:”1687144789077”,
“Name”:”Custom 1”,
“Hour”:”6”,
“Minute”:”30”,
“Date”:”2023-06-19”
}
]
}
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 14 – UPDATING OPENDIRECT SETTINGS

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687139082362”,
“EnableOpenDirect”:false
}
OUTPUT
{
“Status”:”OK”
}

NOTE
The OpenDirect setting (EnbleOpenDirect) cannot be changed once it was enabled when creating a
backupset. Create a new backup set if you need to disable OpenDirect for your backup set.

www.ahsay.com AhsayCBS API Guide | 300 of 450

EXAMPLE 15 – UPDATING MARIADB TYPE BACKUP SETS

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687150109716”,
“ApplicationSettings”:{
“@class”:”com.ahsay.obx.cxp.cloud.MariaDBSettings”,
“Username”:”root”,
“Version”:””,
“Port”:”3306”,
“Host”:”10.16.10.88”,
“Id”:””,
“MysqldumpPath”:”/”,
“:””
}
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 16 – DEDUPLICATION (INCORRECT SCOPE: “SAME_FILES”)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687150109716”,
“DeduplicationSettings”:{
“Scope”:”SAME_FILES”,
“MigrateData”:false,
“Enabled”:false,
“SettingsMigrated”:false,
“Id”:””,
“BlockSize”:262144
}
}
OUTPUT
{
“Status”:”Error”,
“Message”:”Cannot deserialize value of type ‘com.ahsay.obx.cxp.cloud.

www.ahsay.com AhsayCBS API Guide | 301 of 450

 DeduplicationSettings$DeduplicationScope’ from String\”SAME_FILES\”: not
one of the values accepted for Enum class: [ALL_FILES, SAME_FILE]\n
at [Source: (String)\”{\Type\”:\”MariaDB\”, \”Timezone\”:\”1098\”,
\”Delete\” :false, \”LoginName\”:\”obm\”, \”Owner\”:\”w2k16-std\”,
\”DisplayOwner\”: \”w2k16-std\”, \”SysUser\”:\”system\”, \”Os\”:\”Windows
Server 2016\”, \”RunBackupSettings\”:{\”DestiationIDList\”:[],
\”Enabled\”:false, \”BackupType\”:\”\”, \”BackupJobID\”:\”\”, \”Id\”:\”\”},
\”RunOnServer\”: false, \”SelectedShortcutList\”:[],\”V6Passwords\”
:{\”ApplicationPassword\”: \”\”,
\”WinUserAuthPassword\”:\”\”,\”Id”\:\”\”},\"CdpSettings\":{\"@class\":
\"com.ahsay.obx.cxp.obs.CdpSettings\",\"TimeMarkInterval\":30,\
"CdpBackupControlSettings\":{\"Consi\"[truncated 6651 chars]; line: 1,
column: 6343] (through reference chain:
com.ahsay.obx.cxp.obs.BackupSet[\"DeduplicationSettings\"]-
>com.ahsay.obx.cxp.cloud.DeduplicationSettings[\"Scope\"])",
“ExptType”:”com.fasterxml.jackson.databind.exc.InvalidFormatException”
}

EXAMPLE 17 – DEDUPLICATION (SCOPE: “ALL_FILES”)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687150109716”,
“DeduplicationSettings”:{
“Scope”:”ALL_FILES”,
“MigrateData”:false,
“Enabled”:false,
“SettingsMigrated”:false,
“Id”:””,
“BlockSize”:262144
}
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 302 of 450

ADDSELECTSRC
This API can be used to add additional backup source to a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Source

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddSelectSrc.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String User name.
BackupSetID String Obtainable in ListBackupsets API.
SelectedSrc Array of SourceBean One or multiple Source paths, as an array
of “Src”.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

SOURCEBEAN

KEY TYPE DESCRIPTIONS

Src String Note: Special characters for JAVA must be escaped,
for example, “\” must be replaced with “\\”.

www.ahsay.com AhsayCBS API Guide | 303 of 450

 Example:
“Src”:”Microsoft
365/Users/[email protected]/Outlook/Inbox
Example:
“Src”:”C:\\Testing1\\data”
UserName String If username and password are empty, add the ‘src’
without credential.
Password String If username and password are empty, add the ‘src’
without credential.

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“SelectedSrc”:[
{
“Src”:”C:\\New1”
},
{
“Src”:”C:\\New2\\data”
},
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 304 of 450

EXAMPLE 2 – INPUT WITH INCORRECT ESCAPE CHARACTER (e.g. C:\ INSTEAD OF C:\\)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“SelectedSrc”:[
{
“Src”:”C:\New1”
}
]
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] JSON Input Syntax is incorrect!”,
“ExptType”:”java.lang.Exception”
}

EXAMPLE 3 – INPUT WITH INCORRECT ESCAPE CHARACTER DIVIDING SUB-DIRECTORY (E.G. \ INSTEAD
OF \\)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“SelectedSrc”:[
{
“Src”:”C:\\New2\data”
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 305 of 450

REMOVESELECTSRC
This API allows you to remove selected source from a backup set. Running that backup set again
will no longer backup those files from the removed source.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Source

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemoveSelectSrc.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String User name
BackupSetID String Obtainable in ListBackupsets API.
Src String or Array of String One or multiple Source paths.
Note: Special characters for JAVA must
be escaped, for example, “\” must be
replaced with “\\”

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 306 of 450

EXAMPLES

EXAMPLE 1 – INPUT (SINGLE STRING)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“SelectedSrc”:[
{
“Src”:”C:\\New1”
},
{
“Src”:”C:\\New2\\data”
},
]
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2 – INPUT (ARRAY OF STRINGS)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“SelectedSrc”:[
{
“Src”:”C:\\New1”
},
{
“Src”:”C:\\New2\\data”
},
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 307 of 450

ADDDESELECTSRC
This API allows you to add deselected source to a backup set. Running that backup set will no
longer backup files from the deselected source.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Source

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddDeselectSrc.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String User name.
BackupSetID String Obtainable in ListBackupsets API.
DeselectedSrc Array of SourceBean One or multiple Source paths, as an array
of “Src”.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 308 of 450

JSON OBJECTS

SOURCEBEAN

KEY TYPE DESCRIPTIONS

Src String Note: Special characters for JAVA must
be escaped, for example, “\” must be
replaced with “\\”.
Example:
“Src”:”C:\\Testing1\\data”
UserName String If username and password are empty,
add the ‘src’ without credential.
Password String If username and password are empty,
add the ‘src’ without credential.

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“DeselectedSrc”:[
{
“Src”:”C:\\New2”
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 309 of 450

EXAMPLE 2

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“DeselectedSrc”:[
{
“Src”:”C:\\New2”
},
{
“Src”:”C:\\New1”
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 310 of 450

REMOVEDESELECTSRC
This API allows you to remove deselected source from a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Source

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemoveDeselectSrc.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String User name
BackupSetID String Obtainable in ListBackupsets API.
Src String or Array of String Note: Special characters for JAVA must
be escaped, for example, “\” must be
replaced with: “\\”.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 311 of 450

EXAMPLES

EXAMPLE 1 – INPUT (SINGLE STRING)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“Src”:”C:\\New2”
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2 – INPUT (ARRAY OF STRING)

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“Src”:[
”C:\\New2”, “C:\\New1”
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 312 of 450

ADDSCHEDULE (V1,V2)
This API creates a new backup schedule setting on a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Backup Schedule

V1 ADDSCHEDULE.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddSchedule.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 ADDSCHEDULE.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/AddSchedule.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String User name
BackupSetID String Obtainable in ListBackupsets API.
Name String Schedule name.
Type String The value can be one of the following:
DAILY
WEEKLY
MONTHLY
CUSTOM
BackupInterval Integer Support Periodic Schedule backup for all
backup sets.
The value can be “1” or one of the
following:
1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120

www.ahsay.com AhsayCBS API Guide | 313 of 450

 240, 360, 480, 720
(“-1) means periodic schedule is disabled
that is a normal schedule).
Time TimeBean Object Mandatory if “BackupInterval” < ().
FullBackup Boolean Must be true when “BackupInterval” > ()
If it is true, the schedule backup will run
until full backup completed.
Otherwise, it will be stopped after the
duration specified in key “Duration” of
the TimeBean in key “Time”.
SpaceFreeUpEnabled Boolean Remove obsolete files according to
retention policy from backup destination
according to retention policy.
SkipBackupEnabled Boolean True / False
BackupType String It must be empty for File, MySQL,
MariaDB, Lotus Notes, System State, MS
Windows Server 2008, MS Exchange Mail
Level Backup, Cloud File, and Microsoft
365 Exchange Online backup sets.

For the following Backup Types, this

parameter must be filled with one of the
following:

MS Exchange Server (If VSS supported):

DATABASE
LOG
COPY
DIFFERENTIAL

If not VSS supported:

DATABASE
LOG

Oracle Database Server Backup & Lotus

Domino:
DATABASE
LOG

MS SQL Server Backup:

DATABASE
DIFFERENTIAL

www.ahsay.com AhsayCBS API Guide | 314 of 450

 LOG

ShadowProtect System Backup:

COMPLETE
DIFFERENTIAL
INCREMENTAL

MS Hyper-V Backup:
INCREMENTAL
DATABASE

VMware Backup:
VMware ESXi 5.5 / 6 / 6.5 / 6.7 / 7.0 / 8.0
or VMware vCenter 5.5 / 6 / 6.5 / 6.7 /
7.0 / 8.0:
DATABASE
INCREMENTAL

VMware Player 6 / 7 / VMware

Workstation Player 12 / 14 / 15 / 16:
SKIP
POWER-OFF

VMware Workstation 10 / 11 / VMware

Workstation Pro 12 / 14 / 15 /16 or
VMware Fusion 6 / 7 /8 / 10 / 11 / 12
Leave blank
WeekSchedule WeekSchedule Mandatory for weekly schedule.
MonthSchedule MonthSchedule Mandatory for monthly schedule.
CustomSchedule CustomSchedule Mandatory for custom schedule.
MonthlyDateType String Mandatory for monthly schedule.
The value can be one of the following:
DATE
CRITERIA
Period String (Optional)
The following values can be set:
AM
PM
If the parameter "Period" is specified as
AM or PM then the parameter "Hour" is
in 12-hour format. "1", "2", ..."12" can be
set.

www.ahsay.com AhsayCBS API Guide | 315 of 450

 If the parameter "Period" is not specified,
then the parameter "Hour" will default to
24-hour format. "0", "1"... "23" can be
set.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

TIMEBEAN

KEY TYPE DESCRIPTIONS

Hour Integer 00-23
Minute Integer 00-59
Duration Integer (optional) If no value is specified default
value =-1.
The value can be one of the following:
until full backup completed= -1
stop backup after xx hours = 1 to 24
Must be -1 when “BackupInterval” >()

WEEKSCHEDULE

KEY TYPE DESCRIPTIONS

Sun Boolean True / False
Mon Boolean True / False
Tue Boolean True / False
Wed Boolean True / False
Thu Boolean True / False
Fri Boolean True / False
Sat Boolean True / False

www.ahsay.com AhsayCBS API Guide | 316 of 450

MONTHSCHEDULE

KEY TYPE DESCRIPTIONS

Occurrence String The value can be one of the following:
First
Second
Third
Fourth
Last
Criteria The value can be one of the following:
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Weekday
Weekend
Date Integer

CUSTOMSCHEDULE

KEY TYPE DESCRIPTIONS

Year Integer In yyyy format
Month Integer In MM format
Day Integer In dd format

EXAMPLES

EXAMPLE 1 – INPUT DAILY SCHEDULE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“Name”:”DAILYTEST”,
“Type”:”DAILY”,
“BackupInterval”:5,
“FullBackup”:true

www.ahsay.com AhsayCBS API Guide | 317 of 450

 “SpaceFreeUpEnabled”:false,
“SkipBackupEnabled”:false
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2 – INPUT WEEKLY SCHEDULE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“Name”:”WEEKLYTEST”,
“Type”:”WEEKLY”,
“BackupInterval”:-2,
“FullBackup”:true,
“Time”:{
“Hour”:08,
“Minute”:00
},
“SpaceFreeUpEnabled”:true,
“SkipBackupEnabled”:true,
“WeekSchedule”:{
“Sun”:true,
“Mon”:true,
“Tue”:true,
“Wed”:false,
“Thu”:false,
“Fri”:true,
“Sat”:true
}
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 318 of 450

EXAMPLE 3 – INPUT INCORRECT VALUE FOR BACKUPINTERVAL

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“Name”:”DAILYTEST”,
“Type”:”DAILY”,
“BackupInterval”:9,
“FullBackup”:true,
“SpaceFreeUpEnabled”:false,
“SkipBackupEnabled”:false
}
OUTPUT
{
“Status”:”Error”,
“Message”:”ScheduleSettings parameter BackupInterval only can be -1 OR
one of the following value: [1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120,
180,, 240, 480, 720]”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 319 of 450

UPDATESCHEDULE (V1, V2)
This API updates the backup schedule settings on a backup set. It will preserve existing values.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Backup Schedule

V1 UPDATESCHEDULE.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdateSchedule.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 UPDATESCHEDULE.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/UpdateSchedule.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable by calling the ListBackupsets
API.
ID String Schedule ID obtainable by calling the
GetBackupset API.
Name String Schedule name.
Type String The value can be one of the following:
DAILY
WEEKLY
MONTHLY
CUSTOM
BackupInterval Integer Support periodic schedule backup for all
backup set types.

www.ahsay.com AhsayCBS API Guide | 320 of 450

 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, 720
(“-1” means periodic schedule is disabled
that it is a normal schedule.)
Time TimeBean Mandatory if “BackupInterval” < 0.
FullBackup Boolean Enable to backup all files.
If it is true, the schedule backup will run
until full backup completed. Otherwise, it
will be stopped after the duration
specified in key "Duration" of the
TimeBean in key "Time".
Must be true when “BackupInterval” > 0
SpaceFreeUpEnabled Boolean Remove obsolete files according to
retention policy from backup destination
according to retention policy.
SkipBackupEnabled Boolean True / False
BackupType String It must be empty for File, MySQL,
MariaDB, Lotus Notes, System State, MS
Windows Server 2008, MS Exchange Mail
Level Backup, Cloud File, and Microsoft
365 Exchange Online backup sets.

For the following Backup Types, this

parameter must be filled with one of the
following:

MS Exchange Server (If VSS supported):

DATABASE
LOG
COPY
DIFFERENTIAL

If not VSS supported:

DATABASE
LOG

Oracle Database Server Backup & Lotus

Domino:
DATABASE
LOG

www.ahsay.com AhsayCBS API Guide | 321 of 450

 MS SQL Server Backup:
DATABASE
DIFFERENTIAL
LOG

ShadowProtect System Backup:

COMPLETE
DIFFERENTIAL
INCREMENTAL

MS Hyper-V Backup:
INCREMENTAL
DATABASE

VMware Backup:
VMware ESXi 5.5 / 6 / 6.5 / 6.7 / 7.0 / 8.0
or VMware vCenter 5.5 / 6 / 6.5 / 6.7 /
7.0 / 8.0:
DATABASE
INCREMENTAL

VMware Player 6 / 7 / VMware

Workstation Player 12 / 14 / 15 / 16:
SKIP
POWER-OFF

VMware Workstation 10 / 11 / VMware

Workstation Pro 12 / 14 / 15 /16 or
VMware Fusion 6 / 7 /8 / 10 / 11 / 12
Leave blank
WeekSchedule WeekSchedule Mandatory for weekly schedule.
MonthSchedule MonthSchedule Mandatory for monthly schedule.
CustomSchedule CustomSchedule Mandatory for custom schedule.
MonthlyDateType String Mandatory for monthly schedule.
The value can be one of the following:
DATE
CRITERIA
Period String (Optional)
The following values can be set:
AM
PM

www.ahsay.com AhsayCBS API Guide | 322 of 450

 If the parameter "Period" is specified as
AM or PM then the parameter "Hour" is
in 12-hour format. "1", "2", ..."12" can be
set.
If the parameter "Period" is not specified,
then the parameter "Hour" will default to
24-hour format. "0", "1"... "23" can be
set.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

TIMEBEAN

KEY TYPE DESCRIPTIONS

Hour Integer 00-23
Minute Integer 00-59
Duration Integer (optional) If no value is specified default
value =-1.
The value can be one of the following:
until full backup completed= -1
stop backup after xx hours = 1 to 24
Must be -1 when “BackupInterval” >()

WEEKSCHEDULE

KEY TYPE DESCRIPTIONS

Sun Boolean True / False
Mon Boolean True / False
Tue Boolean True / False

www.ahsay.com AhsayCBS API Guide | 323 of 450

Wed Boolean True / False
Thu Boolean True / False
Fri Boolean True / False
Sat Boolean True / False

MONTHSCHEDULE

KEY TYPE DESCRIPTIONS

Occurrence String The value can be one of the following:
First
Second
Third
Fourth
Last
Criteria The value can be one of the following:
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Weekday
Weekend
Date Integer

CUSTOMSCHEDULE

KEY TYPE DESCRIPTIONS

Year Integer In yyyy format.
Month Integer In MM format.
Day Integer In dd format.

www.ahsay.com AhsayCBS API Guide | 324 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“ID”:” 1688116563583”,
“Name”:DAILYTEST,
“Type”:”DAILY”,
“FullBackup”:true,
“Time”:{
“Hour”:21,
“Minute”:30
},
“SpaceFreeUpEnabled”:true,
“SkiBackupEnabled”:true
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 325 of 450

REMOVESCHEDULE
This API removes a schedule from a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Backup Schedule

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemoveSchedule.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable by calling the ListBackupsets
API.
ID String or Array of String Schedule ID obtainable by calling the
String GetBackupset API.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 326 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“ID”:” 1688116563583”,
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 327 of 450

ADDFILTER
This API allows you to add filters t the backup source of a backup set. You can choose to include
or exclude files which match a specific pattern.

The related settings can be found on the AhsayCBS console:

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Source > Apply filters to the backup source

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddFilter.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupset API.
Name String Filter name
TopDir String Appying the filter to this specific folder.
Type String The value can be one of the following:
DEFAULT
CUSTOM
Include Boolean For each of the matched files/folders
under top directory:
Exclude or include them
Only Boolean If it is set to true, it will not include all
unmatched files/folders.
If it is set to false, it will include all
unmatched files/folders.
Apply2Dir Boolean Apply filter to files.
Apply2File Boolean Apply filter to folders.
Patterns Array of PatternBean Refer to PatternBean
Username String If username and password are empty,
add the address without credential.
Password String If username and password are empty,
add the address without credential.

www.ahsay.com AhsayCBS API Guide | 328 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

PATTERNBEAN

KEY TYPE DESCRIPTIONS

Pattern String Description of pattern for filter

EXAMPLES

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“Name”:”filter1”,
“TopDir”:”C:\\test”,
“Type”:”DEFAULT”,
“Include”:false,
“Only”:true,
“Apply2Dir”:true,
“Apply2File”:true,
“Patterns”:[
{
“Pattern”:”.txt”
},
{
“Pattern”:”.png”
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 329 of 450

UPDATEFILTER
This API update setting of a filter from a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Source > Apply filters to the backup source

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemoveFilter.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable by calling the ListBackupsets
API.
ID String Filter ID, obtainable by calling the
GetBackupset API.
Name String Filter name.
TopDir String Appying the filter to this specific folder.
Type String The value can be one of the following:
DEFAULT
CUSTOM
Include Boolean For each of the matched files/folders
under top directory:
Exclude or include them
Only Boolean If it is set to true, it will not include all
unmatched files/folders.
If it is set to false, it will include all
unmatched files/folders.
Apply2Dir Boolean Apply filter to files.
Apply2File Boolean Apply filter to folders.
Patterns Array of PatternBean Refer to PatternBean
Username String If username and password are empty,
add the address without credential.

www.ahsay.com AhsayCBS API Guide | 330 of 450

 Password String If username and password are empty,
add the address without credential.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

PATTERNBEAN

KEY TYPE DESCRIPTIONS

Pattern String Description of Pattern for filter

EXAMPLES

EXAMPLE 1 – INPUT UPDATE THE NAME

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“ID”:” 1687499274011”,
“Name”:”filter2updated”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 331 of 450

EXAMPLE 2 – INPUT THE UPDATE THE PATTERN

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“ID”:” 1687499274011”,
“Name”:”testupdated”,
“Patterns”:[
{
“Pattern”:”.txt123”
},
{
“Pattern”:”.png123”
}
]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 332 of 450

REMOVEFILTER
This API allows you to remove a filter from a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Source > Apply filters to the backup source

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddFilter.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable by calling the ListBackupsets
API.
ID String or Array of String Filter obtainable by calling the
GetBackupset API.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 333 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“ID”:” 1687499274011”,
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 334 of 450

REMOVEBANDWIDTHCONTROL
This API can be used to remove a bandwidth control setting from a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Bandwidth Control

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemoveBandwidthControl.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable by calling the ListBackupsets
API.
ID String or Array of String Filter obtainable by calling the
GetBackupset API.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 335 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687137085658”,
“ID”:” 1687500432855”,
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 336 of 450

ADDBACKUPSET
This API allows you to create a new backup set in a user.

NOTES
You may need to compliment AddBackupSet, with UpdateBackupSet API.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddBackupSet.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Platform String ‘Temporary directory for storing backup
files’ value would be set accordingly.
The value can be set to one of the
following (lower-case):
windows
mac
linux
CloudFileType String The type of cloud file, please use one of
the available types within the set
provided in the table “Destination Type”
CloudBackupSourceSettings JSON Object The settings for the cloud backup source,
the underlying parameters are specific to
each destination type. Please refer to the
tables labeled with “DestinationSettings
(DESTINATION_TYPE)” under
ADDPREDEFINEDDESTINATION API for
the correct format of each cloud file
type.
BackupSetName String Name of the new backup set.
BackupSetType String Backup type of the new backup set.
The value can be set to one of the

www.ahsay.com AhsayCBS API Guide | 337 of 450

 following:
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
Office 365 Exchange Online
Oracle Database Server
ShadowProtect Bare Metal
System State
VMware Virtualization
Linux Bare Metal
Tibero Database Server
Linux Bare Metal
Default value is FILE if BackupSetType is
not specified
BackupMode String Mandatory for BackupSetType =
"Microsoft SQL Server".
Backup mode of MSSQL backup set
0: VSS
1: ODBC
VmVersion String Mandatory for BackupSetType =
"VMware Virtualization".
The value for be set to one of the
following:
APPVERSION_ESX_V2 (VMware ESX
4)
APPVERSION_ESXI_V2 (VMware ESXi
4 or above)
APPVERSION_VMSERVER1 (VMware
Server 1)
APPVERSION_VMSERVER2 (VMware
Server 2)
APPVERSION_WORKSTATION (
VMware Workstation 6 / 6.5 / 7)
APPVERSION_WORKSTATION8

www.ahsay.com AhsayCBS API Guide | 338 of 450

 (VMware Workstation 8 or above)
APPVERSION_PLAYER (VMware
Player 3 / 4 / 5 / 6 / 7 / VMware
Workstation Player 12)
APPVERSION_FUSION (VMware
Fusion 3 / 4)
APPVERSION_FUSION5 (VMware
Fusion 5 / 6 / 7 / 8)
APPVERSION_VCENTER_V2 (VMware
vCenter 4 or above)
MsVmVersion String Mandatory for BackupSetType =
"Microsoft Windows Virtualization".
The value can be set to one of the
following:
Microsoft Hyper-V Server
Microsoft Hyper-V Server R2
Microsoft Hyper-V Server R2
(Failover Cluster)
Microsoft Hyper-V Server 2012
Microsoft Hyper-V Server 2012
(Failover Cluster)
Microsoft Hyper-V Server 2012 R2
Microsoft Hyper-V Server 2012 R2
(Failover Cluster)
Microsoft Hyper-V Server 2016
Microsoft Hyper-V Server 2016
(Failover Cluster)
Microsoft Hyper-V Server 2019
Microsoft Hyper-V Server 2019
(Failover Cluster)
Version String Mandatory for BackupSetType =
"Microsoft Exchange Server".
The value can be set to one of the
following:
8 (MS Exchange Server 2007)
14 (MS Exchange Server 2010)
15 (MS Exchange Server 2013)
15.1 (MS Exchange Server 2016)
15.2 (MS Exchange Server 2019)
DAG13 (MS Exchange Server 2013
(DAG))
DAG16 (MS Exchange Server 2016
(DAG))

www.ahsay.com AhsayCBS API Guide | 339 of 450

 DAG19 (MS Exchange Server 2019
(DAG))
DAG (MS Exchange Server 2010
(DAG))
MsMAPIExVersion String Mandatory for BackupSetType =
"Microsoft Exchange Mail (MAPI)".
The value can be set to one of the
following:
8 (MS Exchange Server 2007)
14 (MS Exchange Server 2010)
15 (MS Exchange Server 2013)
15.1 (MS Exchange Server 2016)
15.2 (MS Exchange Server 2019)
DAG13 (MS Exchange Server 2013
(DAG))
DAG16 (MS Exchange Server 2016
(DAG))
DAG19 (MS Exchange Server 2019
(DAG))
DAG (MS Exchange Server 2010
(DAG))
EncryptionType String Encryption type of a new backup set.
The value can be set to one of the
following:
1. "DEFAULT"
2. "PASSWORD"
3. "CUSTOM"
4. "" = No Encryption
If the Encryption Type is not provided to
the API = Encryption type not defined,
This require the end user to define the
Encryption type in the
AhsayOBM/AhsayACB client for the
backup set.
If the EncryptionType = PASSWORD the
BackupUserPassword must be specified.
BackupUserPassword String Used when EncryptionType = PASSWORD
The BackupUserPassword must match
with the existing user login password on
the AhsayOBM/AhsayACB user account.
Otherwise return error
"The Backup User Password does not
match with the existing user password"

www.ahsay.com AhsayCBS API Guide | 340 of 450

Algorithm String Encryption algorithm of the new backup
set
The value can be set to one of the
following:
Twofish
DESede
AES
Default to AES if not provided.
Method String Encryption method of the new backup
set.
The value can be set to one of the
following:
ECB
CBC
Default to CBC if not provided
Length String Encryption key length (128-bit / 256-bit).
The value can be set to one of the
following:
128
256
Default to 256 if not provided.
Key String Encryption key of the backup set.
The value cannot be empty.
RunOnServer Boolean Run on Server setting for Cloud File and
Microsoft 365 mail backup set.
If this setting is set to "True",
"EncryptionType" cannot be set to
empty.
DestinationList Array of Destination (Optional)
EnableOpenDirect Boolean Enable the feature of OpenDirect.
Note: Once it is enabled or disabled, it
cannot be changed later on.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
BackupSetID String Backup Set ID of the created backup
sent.
Message String Error message, will only be displayed if

www.ahsay.com AhsayCBS API Guide | 341 of 450

 the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

DESTINATION

KEY TYPE DESCRIPTIONS

Type String The value can be one of the following:
OBS
Local
Name String (Optional)
If blank and the Type=”OBS” the default
value for the name is “CBS”.
If blank and the Type=”Local”, “the
default value for the name is “Local”.

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetName”:”Test_Name”,
“BackupSetType”:”Cloud File”,
“EncryptionType”:”DEFAULT”,
“Length”:”128”,
“Key”:”123456”,
“Platform”:”windows”,
“RunOnServer”:false
“CloudFileType”:”GDrive”,
“CloudBackupSourceSettings”:{
“Token”:4/0AeaYSHDXuv7rofdyAc20-
g1Xoy4YoYite1Auly8NJA84CIGHtlmY9CSZ2ubfTN1N7pFqwQ”
}
OUTPUT
{
“Status”:”OK”,

www.ahsay.com AhsayCBS API Guide | 342 of 450

 “BackupSetID”:”1687501131522”
}

EXAMPLE 2 – CLOUDFILETYPE PARAMETER IS MISSING

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetName”:”API Cloud File Invalid”,
“Backup Set Type”:”Cloud File”,
“EncryptionType”:”DEFAULT”,
“Length”:”128”,
“Key”:”hash”,
“Platform”:”windows”,
“RunOnServer”:false
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Invalid Platform. Please specify one of the
following: windows / mac / linux”,
“ExptType”:”java.lang.Exception”
}

EXAMPLE 3 – PLATFORM PARAMETER INCORRECT - WRONG PLATFORM FOR BACKUP SET TYPE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetName”:”Test_Name”,
“BackupSetType”:”FILE”,
“Platform”:”mac”,
“DestinationList”:[
{
“Name”:”AhsayCBS”,
“Type”:”OBS”
}
]
}
OUTPUT

www.ahsay.com AhsayCBS API Guide | 343 of 450

{
“Status”:”Error”,
“Message”:”[Error]Backup set type ‘Tibero Database Server’ is not
supported on platform ‘mac’”,
“ExptType”:”java.lang.Exception”
}

www.ahsay.com AhsayCBS API Guide | 344 of 450

ADDALLOWEDIP
This API allows you to add a range of IP of users which are allowed to perform restore in their
computers.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > IP Allowed for Restore

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddAllowedIP.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
NewAllowedIP AllowedIPBean Refer to AllowedIPBean

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

JSON OBJECTS

ALLOWEDIPBEAN

KEY TYPE DESCRIPTIONS

StartIP String Starting value of allowable IP
EndIP String Ending value of allowable IP

www.ahsay.com AhsayCBS API Guide | 345 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687501131522”,
“NewAllowedIP”:{
“StartIP”:”1.1.1.1”,
“EndIP”:”255.255.255.255”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 346 of 450

REMOVEALLOWEDIP
This API allows you to remove an IP range from the allowed IP list. Users whose IP is not in the
allowed IP list are not able to perform restore in their computers.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > IP Allowed for Restore

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemoveAllowedIP.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
AllowedIP AllowedIPBean ID of allowed IP to remove.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 347 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687501131522”,
“AllowedIP”:” 1687501909703”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 348 of 450

DELETEBACKUPDATA
This API only works for backups from version 6 or older backup clients.

URL
https://CBS.EXAMPLE.COM/obs/api/json/DeleteBackupData.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
BackupSetName String Either backup set ID or backup set name
should be provided.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 349 of 450

DELETEBACKUPFILE
This API only works for backups from version 6 or older backup clients.

URL
https://CBS.EXAMPLE.COM/obs/api/json/DeleteBackupData.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetName String Either backup set ID or backup set name
should be provided.
InBackupJob String Backup Job ID.
Path String Path to the backup files.
Type String The value can be one of the following:
F
D
I
BackupByJob String Backup Job ID.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 350 of 450

DELETEBACKUPSET
This API allowed you to delete a backup set of a user.

URL
https://CBS.EXAMPLE.COM/obs/api/json/DeleteBackupSet.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Backup set ID.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 351 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687152855403”
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2 – BACKUP SET CONTAINS NON-AHSAYCBS DESTINATION

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687501131522”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”Cannot delete the backup set ‘Test_Name(1687501131522)’
because the standard destination ‘dest_Local’ is used. Please delete the
backup set via backup client console.”
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 352 of 450

EXAMPLE 3 – LOGIN NAME DOES NOT EXIST OR INCORRECT

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”test_user”,
“BackupSetID”:”1687501131522”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[UserCacheManager.NoSuchUserExpt] User ‘test_user’ not
found.”,
“ExptType”:”com.ahsay.obs.core.dbs.ad”
}

EXAMPLE 4 – BACKUP SET ID IS INCORRECT

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687501131500”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”Backup set ‘1687501131500’ not found.”,
“ExptType”:”com.ahsay.obs.core.dbs.DbsException”
}

www.ahsay.com AhsayCBS API Guide | 353 of 450

GETBACKUPJOBPROGRESS
This API can be used to retrieve current progress of a backup job.

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

Monitoring > Backup / Restore Logs > Backup Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetBackupJobProgress.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Backup set ID.
DestinationID String Obtainable by calling the GetbackupSets
API.
BackupJobID String Obtainable by calling the GetbackupSets
API.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Record Refer to “Record”
Message String Error message, will only be displayed if
the status is “Error”.
ExptType String The type of exception, will only be
displayed if the status is “Error”.

www.ahsay.com AhsayCBS API Guide | 354 of 450

JSON OBJECTS

RECORD

KEY TYPE DESCRIPTIONS

ID String ID of record
LoginName String Client user name.
Owner String Owner of Record
UserId String Unique to each Backup User
StartTime String In yyyy-MM-dd HH:mm:ss format.
EndTime String In yyyy-MM-dd HH:mm:ss format.
BackupSetID String ID of backup set
BackupSetName String Name of backup set
CurrentFilename String Name of current file
FileUploadTime String In yyyy-MM-dd HH:mm:ss format.
CurrentFileCount String Count of current file
TotalFileCount String Total count of all files
UploadedFileSize String Total size of uploaded files
TotalFileSize String Total size of all files

www.ahsay.com AhsayCBS API Guide | 355 of 450

EXAMPLES

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687505199600”,
“DestinationID”:”1687505211240”,
“BackupJobID”:”2023-06-23-15-27-57”
}
OUTPUT
{
“Status”:”OK”,
“Data”:{
“BackupSetName”:”default-backup-set-name-1”,
“LoginName”:”obm”,
“Owner”:””,
“EndTime”:”2023-06-23 15:29:37”,
“TotalFileCount”:”70”,
“StartTime”:”2023-06-23 15:27:58”,
“FileUploadTime”:”2023-06-23 15:28:16”,
“BackupSetID”:”1687505199600”,
“UserId”:”obm”,
“UploadedFileSize”:”70479290”,
“CurrentFilename”:”C:\\Users\\ahsay\\Desktop\\file_sample.exe”,
“TotalFileSize”:”78477452”,
“ID”:”2023-06-23-15-27-57”,
“CurrentFileCount”:”0”
}

www.ahsay.com AhsayCBS API Guide | 356 of 450

GETBACKUPSET (V1, V2)
This API can be used to retrieve information of a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name%

V1 GETBACKUPSET.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetBackupSet.do
DEPRECATED SINCE VERSION:
7.15.6.38

V2 GETBACKUPSET.DO

URL
https://CBS.EXAMPLE.COM/obs/api/json/2/GetBackupSet.do
AVAILABLE SINCE VERSION:
9.7.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.

www.ahsay.com AhsayCBS API Guide | 357 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array Information of the backup set.
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".
DeduplicationSettings Object Refer to DeduplicationSettings in
UpdateBackupSet API.

JSON OBJECTS

DATA

For details on all parameters returned by GetBackupSet.do, please refer to the input
parameters outlined in the UpdateBackupSet section.

ARRAY OF DESTINATIONLIST (DATA{}:DESTINATIONSETTINGS{}:DESTINATIONLIST[])

KEY TYPE DESCRIPTIONS

@class String The value can be one of the following:
com.ahsay.obx.cxp.cloud.FileSettings
com.ahsay.obx.cxp.cloud.LotusDominoSettings
com.ahsay.obx.cxp.cloud.LotusNotesSettings
com.ahsay.obx.cxp.cloud.MSExchangeSettings
com.ahsay.obx.cxp.cloud.MSExMailboxSettings
com.ahsay.obx.cxp.cloud.MSSQLSettings
com.ahsay.obx.cxp.cloud.MSHypervSettings
com.ahsay.obx.cxp.cloud.MSWindowsSystemSettings
com.ahsay.obx.cxp.cloud.MySQLSettings
com.ahsay.obx.cxp.cloud.OracleSettings
com.ahsay.obx.cxp.cloud.ShadowProtectSettings
com.ahsay.obx.cxp.cloud.MSWindowsSystemStateSetti
ngs
com.ahsay.obx.cxp.cloud.VMwareSettings
com.ahsay.obx.cxp.cloud.Office365ExchangeOnlineSett
ings
com.ahsay.obx.cxp.cloud.CloudFileSettings
com.ahsay.obx.cxp.cloud.MariaDBSettings

www.ahsay.com AhsayCBS API Guide | 358 of 450

 com.ahsay.obx.cxp.cloud.TiberoSettings
com.ahsay.obx.cxp.cloud.LinuxBareMetalSettings
DataMigrationMappingMergedToIn Boolea True / False
dex n
String For v6 backup set. Statuses "NotStarted", "Running",
DataMigrationStatus
"Finished", "Verified".
DestinationKey String Key of Destination
HostName String Hostname or IP of Host
Id String ID of Destination
IndexMigrateLastAccess Long Last Index migration access
Name String Name of Destination
Password Password used to login to Destination
Port Long Port used by Destination
QuotaInfo String Quota of Destinations (if any)
Boolea True / False
ReadOnly
n
Boolea True / False
RunDirectEnabled
n
Sslcertificates Array Array list of SSL Certificates
Statistics Object Refer to “Statistics”
TopDir String First Directory
Type String Type of Directory
UserName String UserName used to access directory
Boolea True / False
UsingProxy
n
Boolea True / False
UsingSSL
n
String For v6 backup set.
Check if other cluster nodes were performing
V6ClusterMigrateLock
migration
“Empty” = Not running Stage 1 / No need to lock.
V6DataMigrateLock String Unused. For v6 backup set.
Boolea For v6 backup set.
n False = v7+ backup set.
V6Index2Migrate
True = Backup Set still v6 and hasn’t Stage-1 (v6 index
migration)

www.ahsay.com AhsayCBS API Guide | 359 of 450

STATISTICS (DATA{}:DESTINATIONSETTINGS{}:DESTINATIONLIST{}:STATISTICS{})

KEY TYPE DESCRIPTIONS

LastBackupClientVersion String Version used with last backup
LastBackupCompleteTime Long Completion time of last backup
LastBackupJobID String Date YYYY-MM-DD-HH-MM-SS.
LastBackupStartTime Long Starting time of last backup
LastCdpBackupCompleteTime Long Completion time of last Cdp backup
LastCdpBackupStartTime Long Start time of last Cdp backup
LastDeltaMergeTime Long Time of last Delta Merge
LastDICTime Long Time of last DIC
LastDICVersion String Version of last DIC
LastOffice365DSCTime Long Time of last Office 365 DSC
LastRestoreTime Long Time of last restore
LastStorageRebuildTime Long Time of last storage rebuild
LastSuccessBackupJobID String Date YYYY-MM-DD-HH-MM-SS.
Pdicrun Boolean True / False
TotalBackupCount Integer Total count of backups
TotalRestoreCount Integer Total count of restores
TotalRestore Object Refer to “TotalRestore”
LastBackup Object Refer to “LastBackup”
DataArea Object Refer to “DataArea”
DedupeSaving Object Refer to “DedupeSavings”
RetentionArea Object Refer to “RetentionArea”
LastRestore Object Last restore job
TotalBackup Object Total backup jobs

TOTALRESTORE (DATA{}:DESTINATIONSETTINGS{}:DESTINATIONlIST[]:STATISTICS{}:TOTALRESTORE{})

KEY TYPE DESCRIPTIONS

Type String TOTAL_RESTORE
FileCount Integer Count of files
CompressedSize Long Size of compressed files
UncompressedSize Long Size of uncompressed files

www.ahsay.com AhsayCBS API Guide | 360 of 450

LASTBACKUP (DATA{}:DESTINATION[]:STATISTICS{}:LASTBACKUP{})

KEY TYPE DESCRIPTIONS

Type String LAST_BACKUP
FileCount Integer Count of files
CompressedSize Long Size of compressed files
UncompressedSize Long Size of uncompressed files

DATAAREA (DATA{}:DESTINATIONSETTINGS{}:DESTINATIONLIST[]:STATISTICS{}:DATAAREA{}

KEY TYPE DESCRIPTIONS

Type String DATA_AREA
FileCount Integer Count of files
CompressedSize Long Size of compressed files
UncompressedSize Long Size of uncompressed files

DEDUPESAVING
(DATA{}:DESTINATIONSETTINGS{}:DESTINATIONLIST[]:STATISTICS{}:DEDUPESAVING{})

KEY TYPE DESCRIPTIONS

Type String DEDUPE_SAVING
FileCount Integer Count of files
CompressedSize Long Size after deduplication.
UncompressedSize Long Uncompressed original size.

RETENTIONAREA
(DATA{}:DESTINATIONSETTINGS{}:DESTINATIONLIST{}:STATISTICS{}:RETENTIONAREA{})

KEY TYPE DESCRIPTIONS

Type String RETENTION_AREA
FileCount Integer Count of files
CompressedSize Long Size of compressed files
UncompressedSize Long Size of uncompressed files

www.ahsay.com AhsayCBS API Guide | 361 of 450

LASTRESTORE (DATA{}:DESTIATIONSETTINGS{}:DESTINATIONLIST[]:STATISTICS{}:LASTRESTPRE{})

KEY TYPE DESCRIPTIONS

Type String LAST_RESTORE
FileCount Integer Count of files
CompressedSize Long Size of compressed files
UncompressedSize Long Size of uncompressed files

TOTALBACKUP (DATA{}:DESTINATIONSETTINGS{}:DESTINATIONLIST[]:STATISTICS{}:TOTALBACKUP{})

KEY TYPE DESCRIPTIONS

Type String TOTAL_BACKUP
FileCount Integer Count of files
CompressedSize Long Size of compressed files
UncompressedSize Long Size of uncompressed files

MODULEUSAGE

KEY TYPE DESCRIPTIONS

ModuleUsage Long Usage of module license by the backup
set.
ModuleType String Type of module used by the backup set.
One of the ff:
Office 365Mail
MSExMailbox
MSHyperVVM
VMwareVM
HostCount Long Usage of OBM / ACB license by the
backup set.

www.ahsay.com AhsayCBS API Guide | 362 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”ACB”,
“BackupSetID”:”1692674960375”
}
OUTPUT
{
“Status”:”OK”,
“Data”:{
“Timezone”:”1098”,
“Delete”:false,
“Owner”:null,
“DisplayOwner”:”-“,
“Os”:”windows”,
“RunBackupSettings”:{
“DestinationIDList”:[],
“Enabled”:false,
“BackupType”:””,
“BackupJobID”:””,
“Id”:””
},
“RunOnServer”:false,
“V6Passwords”:{
“ApplicationPassword”:””,
“WinUserAuthPassword”:””,
“Id”:””
},
“SelectedShortcutList”:[],
“EnsureTopDirExistenceInLogin”:true,
“PlatformSupportVMwareRunDirect”:true,
“PreCommandList”:[],
“ApplicationSupportHyperVRunDirect”:false,
“RecycleBinSettings”:{
“Enabled”:true,
“Id”:””,
“RetentionPeriod”:7
},
“Name”:”default-backup-set-name-1”,
“FollowLink”:true,
“NasEncryptionKey”:null,
“ApplicationSupportBackupMacResourceData”:false,

www.ahsay.com AhsayCBS API Guide | 363 of 450

 “DataMigrationSettings”:{
“IntegrityCheckLastAccess”:0,
“DataMigrationMappingStart”:false,
“Id”:””,
“MigrationProgress”:{
“ReadOnly”:false,
“NumOfCompletedFiles”:0,
“CurrentMigratingFilePath”:””,
“Id”:””,
“TotalNumOfFiles”:0
},
“SpaceFreeUpLastAccess”:0
},
“OpenDirectEnabled”:false,
“EnableBackupEFSFile”:true,
“InFileDeltaSettings”:{
“MaxDeltaRatio”:50,
“MinDeltaFileSize”:26214400,
“MonthlyInFileDeltaSchedule”:{
“Month”:[
“”,
“”,
“”,
“”,
“”,
“”,
“”,
“”,
“”,
“”,
“”,
“”,
],
“Criteria”:”Friday”,
“Occurrence”:”First”,
“Date”:0
},
“MaxNumOfDelta”:100,
“DeltaBlockSize”:-1,
“DeltaMergeEnabled”:false,
“UploadFullIfGenDeltaFailed”:true,
“Enabled”:true,
“WeeklyInFileDeltaSchedule”:{
“Day”:[
“”,
“”,
“”,
“”,

www.ahsay.com AhsayCBS API Guide | 364 of 450

 “”,
“”,
“”,
},
“Id”:””,
“DefaultDeltaType”:”D”
},
“EncryptionSettings”:{
“Type”:”DEFAULT”,
“KeyType”:”hash”,
“InputStream”:{},
“Mode”:”CBC”,
“NasKey”:null,
“Id”:””,
“Algorithm”:”AES”,
“KeyLength”:256,
“Key”:””
},
“LogoutType”:””,
“BackupTargetAsUNCPath”:false,
“LogRetentionDays”:-1,
“UsedQuota”:0,
“FilterSettings”:{
“Enabled”:false,
“FilterList”:[],
“Id”:””
},
“DestinationSettings”:{
“ConcurrencyLevel”:1,
“MaxDestination”:1,
“Id”:””,
“DestinationList”:[
{
“DeleteToken”:””,
“Immutable”:false,
“V6DataMigrateLock”:””,
“Port”:0,
“Name”:”AhsayCBS”,
“UsingSSL”:false,
“V6ClusterMigrateLock”:””,
“DataMigrationMappingMergedToIndex”:true,
“IndexMigrateLastAccess”:0,
“HostName”:null,
“Password”:null,
“DestinationKey”:”OBS”,
“ReadOnly”:false,
“@class”:”com.ahsay.obx.cxp.obx.ObsDestination”,
“UserName”:null,

www.ahsay.com AhsayCBS API Guide | 365 of 450

 “UsingProxy”:false,
“DataMigrationStatus”:”Verified”,
“Statistics”:{
“TotalRestore”:{
“Type”:”TOTAL_RESTORE”,
“FileCount”:0,
“CompressedSize”:0,
“UncompressedSize”:0
},
“LastBackup”:{
“Type”:”LAST_BACKUP”,
“FileCount”:0,
“CompressedSize”:0,
“UncompressedSize”:0
},
“DataArea”:{
“Type”:”DATA_AREA”,
“FileCount”:0,
“CompressedSize”:0,
“UncompressedSize”:0
},
“LastDICTime”:-1,
“LastOffice365DSCTime”:-1,
“LastCdpBackupStartTime”:-1,
“Pdicrun”:false,
“TotalBackupCount”:0,
“LastRestore”:{
“Type”:”LAST_RESTORE”,
“FileCount”:0,
“CompressedSize”:0,
“UncompressedSize”:0
},
“LastDICVersion”:””,
“LastSuccessBackupJobID”:””,
“TotalRestoreCount”:0,
“LastBackupJobID”:””,
“RecycleBin”:{
“Type”:”RECYCLE_BIN”,
“FileCount”:0,
“CompressedSize”:0,
“UmcompressedSize”:0
},
“DedupeSaving”:{
“Type”:”DEDUPE_SAVING”,
“FileCount”:0,
“CompressedSize”:0,
“DataSize”:0,
“OriginalSize”:0,

www.ahsay.com AhsayCBS API Guide | 366 of 450

 “UncompressedSize”:0
},
“LastBackupClientVersion”:null,
“LastBackupCompleteTime”:-1,
“LastDeltaMergeTime”:-1,
“LastBackupStartTime”:-1,
“RetentionArea”:{
“Type”:”RETENTION_AREA”,
“FileCount”:0,
“CompressedSize”:0,
“UncompressedSize”:0
},
“LastRestoreTime”:-1,
“LastStorageRebuiltTime”:-1,
“LastCdpBackupCompleteTime”:-1,
“TotalBackup”:{
“Type”:”TOTAL_BACKUP”,
“FileCount”:0,
“CompressedSize”:0,
“UmcompressedSize”:0
},
“LastIndexUploadedBackupJobID”:null,
},
“V6Index2Migrate”:false,
“Type”:”OBS”,
“QutaInfo”:””,
“Id”:”1703141860328”,
“Sslcertificates”:[],
“RunDirectEnabled”:false,
“CloudbackoGoDrive”:false,
“TopDir”:null
}
]
},
“EffectiveOwner”:”-“,
“BackupJobName”:”2023-12-21-16-07-10”,
“ApplicationSupportVMwareRunDirect”:false,
“RestoreDrillSettings”:{
“UploadKey”:False,
“RestoreInterval”:6,
“Enable”:true,
“Id”:””
},
“ReminderSettings”:{
“OfflineBackupReminderComputerName”:””,
“BackupIntervalHour”:0,
“LogoutBackupReminderEnabled”:false,
“BackupIntervalDay”:1,

www.ahsay.com AhsayCBS API Guide | 367 of 450

 “ShowOfflineBackupReminder”:false,
“OfflineNotificationDay”:7,
“OfflineBackupEnabled”:false,
“Id”:””,
“LogoutBackupReminderComputerName”:””
},
“ReadOnlySelectedSourceKeyList”:[],
“EffectiveFilterList”:[],
“TransferSize”:262114,
“LanPassword”:”y8/BxMA=”,
“WorkingDir”:””,
“ApplicationSettings”:{
“@class”:”com.ahsay.obx.cxp.cloud.TiberoSettings”,
“LoginID”:”SYS”,
“Version”:””,
“Port”:”1234”,
“Host”:”127.0.0.1”,
“LastArchivedLog”:””,
“Id”:””,
“Password”:””,
“Sid”:””
},
“Ewstype”:false,
“TotalQuota”:0,
“FileViewerEnabled”:true,
“AllowEmptyPathSource”:false,
“BackupTypes”:[],
“UploadPermission”:true,
“Id”:”1703141639743”,
“ApplicationSupportOpenDirect”:false,
“VerifyBucketLocationInLogin”:true,
“BandwidthControlSettings”:{
“Mode”:”share”,
“Enabled”:false,
“Id”:””,
“BandwidthControlList”:[]
},
“ProxySettings”:null,
“CloudName”:””,
“ScheduleSettings”:{
“DailyScheduleList”:[],
“WeeklyScheduleList”:[],
“CustomScheduleList”:[],
“LastRosPeriodJobAlertTime”:0,
“MonthlyScheduleList”:[],
“ComputerName”:””,
“Enable”:false,
“Id”:””,

www.ahsay.com AhsayCBS API Guide | 368 of 450

 “LastRosPeriodJobTriggerTime”:0
},
“DeselectedSourceList”:[],
“DeleteTempFile”:true,
“ReadOnlyDeselectedSourceKeyList”:[],
“NoBackupSourceSelected”:true,
“PostCommandList”:[],
“LanUsername”:”system”,
“ClientVersion”:””,
“LastUploadLogToServerTime”:-1,
“CloudFileSourceType”:null,
“TotalUploaded”:0,
“AllowedIPList”:[
{
“ReadOnly”:false,
“StartIP”:”0.0.0.0”,
“Id”:”1703141906825”,
“EndIP”:”255.255.255.255”,
},
],
“ModuleUsage”:{
“ModuleUsage”:0,
“HostCount”:1
},
“DeduplicationSettings”:{
“MigrateData”:false,
“Scope”:”ALL_FILES”,
“Enabled”:true,
“SettingsMigrated”:false,
“Id”:””,
“BlockSize”:131072
},
“ApplicationSupportRunDirect”:false,
“class”:”com.ahsay.obx.cxp.obx.BackupSet”,
“RetentionPolicySettings”:{
“AdvancedRetentionPolicyList”:[],
“Type”:”SIMPLE”,
“OverlapSensitive”:false,
“Period”:7,
“Id”:””,
“Unit”:”DAYS”,
},
“SubIndexType”:false,
“DefaultBSetSettings”:{
“Owner”:””,
“EnfBSet”:false,
“Category”:””,
“DefBSet”:false,

www.ahsay.com AhsayCBS API Guide | 369 of 450

 “Id”:””
},
“DeltaType”:”I”,
“Version7Checked”:false,
“ResolvedFromDefaultBset”:false,
“CompressType”:”SnappyDefaultCOmpression”,
“Type”:”Tibero Database Server”,
“LocalFilesBackup”:true,
“DisplayDestination”:null,
“LanDomain”:””,
“ShadowCopyEnabled”:true,
“LocalCopySettings”:{
“Zip”:true,
“DestinationPath”:””,
“SkipOffsiteBackup”:false,
“SetPermission”:false,
“Enabled”:false,
“LocalCopyRetentionPolicySettings”:{
“ReadOnly”:false,
“Enabled”:false,
“Period”:7,
“Id”:””,
“Unit”:”DAYS”,
},
“Id”:””
},
“SettingsMigrated”:false,
“AllHostClientVersion”:null,
“SelectedSourceList”:[]
}
}

www.ahsay.com AhsayCBS API Guide | 370 of 450

EXAMPLE 2- SNIPPET OF DEDUPLICATION SETTINGS

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687505199600”,
“DestinationID”:”1687505211240”,
“BackupJobID”:”2023-06-23-15-27-57”
}
OUTPUT
{
],
“DeduplicationSettings”:{
“MigrateData”:false,
“Scope”:”ALL_FILES”,
“Enabled”:true,
“SettingsMigrated”:true,
“Id”:””,
“BlockSize”:65536
},
}

EXAMPLE 3- SNIPPET OF MODULEUSAGE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”ACB”,
“BackupSetID”:”1692674960375”
}
OUTPUT
{
],
“ModuleUsage”:{
“ModuleUsage”:1,
“ModuleType”:”Office365Mail”,
“HostCount”:1
}
}

www.ahsay.com AhsayCBS API Guide | 371 of 450

LISTBACKUPFILES
This API only works for backup data backed up by version 6 or older backup clients.

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListBackupFiles.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Backup set ID.
BackupJobID String Obtainable in GetBackupsets API.
Path String Path to the backup files.
ListAll Boolean If it is true, all files ar elisted, starting
from root directory.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array Information of the backup set.
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 372 of 450

JSON OBJECTS

BACKUP FILE

KEY TYPE DESCRIPTIONS

Type String D is for directory, and F is for file.
Name String Name of backup file
FullPath String Path to the file.
OriginalFileSize Long Original file size of backup
FileSize Long Size of backup file
BackupedByJob String Job that backed up file
InBackupJob String Backup jobs with Backup file
LastModified Long Date of last change

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687750405259”,
“BackupJobID”:”2023-06-26-11-43-15”,
“Path”:”C:\\”
“ListAll”:true
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“OriginalFileSize”:0,
“LastModified”:”0”,
“Type”:”0”,
“InBackupJob”:”Current”,
“FullPath”:”C:\\”,
“BackupedByJob”:”2023-06-26-11-33-52”,
“Name”:””,
“FileSize”:1536
},
{
“OriginalFileSize”:0,
“LastModified”:”0”,

www.ahsay.com AhsayCBS API Guide | 373 of 450

 “Type”:”D”,
“InBackupJob”:”Current”,
“FullPath”:”C:\\Users”,
“BackupedByJob”:”2023-06-26-11-33-52”,
“Name”:”Users”,
“FileSize”:1536
},
{
“OriginalFileSize”:174,
“LastModified”:”1575709962747”,
“Type”:”F”,
“InBackupJob”:”Current”,
“FullPath”:”C:\\Users\\Public\\Desktop\\desktop.ini”,
“BackupedByJob”:”2023-06-26-11-33-52”,
“Name”:”desktop.ini”,
“FileSize”:1716
}
]
}

www.ahsay.com AhsayCBS API Guide | 374 of 450

LISTBACKUPJOBMODE
This API can be used to list all backup jobs information at a specific date.

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

Monitoring > Backup / Restore Logs > Backup Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListBackupJobMode.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
BackupDate String In yyyy-MM-dd format.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array See “Record”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 375 of 450

JSON OBJECTS

RECORD

KEY TYPE DESCRIPTIONS

ID String ID of record
LoginName String Client user name.
Owner String Owner of record
UserId String Unique to Backup User
StartTime String In yyyy-MM-dd:mm:ss format.
EndTime String In yyyy-MM-dd:mm:ss format.
BackupSetID String ID of backup set
BackupSetName String Name of backup set
BackupJobMode String The BackupJobMode response can be “R”, “M”, or “S”.
R = Remote backup
M = Manual backup
S = Scheduled backup
null = no backup

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupDate”:”2023-06-26-11-33-52”
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“BackupSetName”:”v6 File Backup”,
“LoginName”:”obm”,
“Owner”:””,
“EndTime”:”2023-06-26 11:34:15”,
“UserId”:”obm”,
“StartTime”:”2023-06-26-11-33-52”,
“BackupJobMode”:”M”,
“BackupSetID”:”1687750405259”
}

www.ahsay.com AhsayCBS API Guide | 376 of 450

LISTBACKUPJOBS
This API can be used to show the basic information of all backup jobs performed by a specific
user.

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

Monitoring > Backup / Restore Logs > Backup Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListBackupJobs.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
SkipEmpty Boolean If it is true, backup set with no files is
skipped.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array See “Backup Set”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 377 of 450

JSON OBJECTS

BACKUP SET

KEY TYPE DESCRIPTIONS

BackupSetID String ID of backup set
Removed Boolean Shows whether the backup set is
removed.
BackupJob Array of Strings Array list of backup jobs

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“BackupJob”:[
“2023-06-26-11-33-52”
],
“BackupSetID”:”1687750405259”,
“Removed”:false
}
]
}

www.ahsay.com AhsayCBS API Guide | 378 of 450

LISTBACKUPJOBSTATUS
This API can be used to show detailed information such as destination ID and job status of all
backup jobs performed by a specific user on a specific date.

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

Monitoring > Backup / Restore Logs > Backup Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListBackupJobStatus.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
Owner String Sub admin username (if applicable).
LoginName String Client user name.
BackupDate String In yyyy-MM-dd format.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array See “Record”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 379 of 450

JSON OBJECTS

RECORD

KEY TYPE DESCRIPTIONS

ID String ID of record
LoginName String Client user name.
Owner String Sub admin username (if user owned by
sub admin).
UserId String Unique to each backup user
StartTime String In yyyy-MM-dd HH:mm:ss format.
EndTime String In yyyy-MM-dd HH:mm:ss format.
BackupJobStatus String Job status. BS_STOP_SUCCESS if
successful backup.
It varies with the errors found if failed
the backup.
BackupSetID String ID of backup set
BackupSetName String Name of backup set
UploadSize String Size of upload
RunVersion String Version where job was run on
SuccessDatabase String Database of successful jobs
MissedDatabase String Databased of missed jobs
SuccessVirtualMachine String If backup is VM type, SuccessPublicFolder
is returned instead.
MissedVirtualMachine String If backup is VM type, MissedPublicFolder
is returned instead.
SuccessPublicFolder String Only returned if backup is VM type.
MissedPublicFolder String Only returned if backup is VM type.
DestinationID String ID of chosen Destination

www.ahsay.com AhsayCBS API Guide | 380 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Owner”:””,
“LoginName”:”ACB”,
“BackupDate”:”2023-08-16”
}
OUTPUT
{
“Status”:”Error”,
“Data”:[
{
“BackupJobStatus”:”BS_STOP_BY_USER”,
“BackupSetName”:”TEST 1”,
“LoginName”:”ACB”,
“Owner”:””
“MissedDatabase”:””,
“EndTime”:”2023-08-16 14:06:33”,
“SuccessDatabase”:””,
“SuccessPublicFolder”:””,
“StartTime”:”2023-08-16 14:06:18”,
“BackupSetID”:”1692164297907”,
“MissedPublicFolder”:””,
“DestinationID”:”1692164297907”,
“UserId”:”ACB”,
“UploadSize”:0,
“RunVersion”:”9.7.0.0”,
“ID”:”2023-08-16-14-16-17”
}

www.ahsay.com AhsayCBS API Guide | 381 of 450

LISTBACKUPSETS
This API can be used to show the name, type, and ID of all backup sets of a specific user.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListBackupSets.do
AVAILABLE SINCE VERSION:
9.7.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
ListAll Boolean True or False; shows all information for
all Backup Sets of specified Backup User.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".
ModuleUsage JSON Object See “ModuleUsage”

www.ahsay.com AhsayCBS API Guide | 382 of 450

JSON OBJECTS

BACKUP SET

KEY TYPE DESCRIPTIONS

ID String ID of backup set
Name String Name of backup set
Type String The value can be one of the following:
FILE
Cloud File
Lotus Domino
Lotus Notes
Microsoft Exchange Server
Microsoft Exchange Mail (MAPI)
Microsoft SQL Server
Microsoft Windows Virtualization
Microsoft Windows System Backup
MySQL
Oracle Database Server
ShadowProtect Bare Metal
System State
VMware Virtualization
Office 365 Exchange Online

MODULEUSAGE

KEY TYPE DESCRIPTIONS

ModuleUsage Long Usage of module license by the backup
set.
ModuleType String Type of module used by the backup set.
One of the ff:
Office365Mail
MSExMailbox
MSHyperVVM
VMwareVM
HostCount Long Usage of OBM / ACB license by the
backup set.

www.ahsay.com AhsayCBS API Guide | 383 of 450

EXAMPLES

EXAMPLE 1 – IF “LISTALL” PARAMETER IS NOT USED OR IS ‘FALSE’

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”ACB”
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“Type”:”FILE”,
“ID”:”1692320086130”,
“Name”:”BackupSet-1”
},
{
“Type”:”Office 365 Exchange Online”,
“ID”:”1692322592995”,
“M365-1”
},
{
“Type”:”Office 365 Exchange Online”,
“ID”:”1692674960375”,
“Name”:”M365-2”
]
}

www.ahsay.com AhsayCBS API Guide | 384 of 450

EXAMPLE 2 – IF “LISTALL” PARAMETER IS SET TO ‘TRUE’ / SNIPPET OF MODULEUSAGE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”ACB”,
“ListAll”:true
}
OUTPUT
{
...
“ModuleUsage”:{
“ModuleUsage”:5,
“ModuleType”:”Office365Mail”,
“HostCount”:1
}
}

NOTE
API results will vary depending on the usage of the parameter “ListAll”.

www.ahsay.com AhsayCBS API Guide | 385 of 450

RUNBACKUP
This API can be used to start a backup for a specific user, or to cancel a pending backup job
from the server initiated backup job list.

URL
https://CBS.EXAMPLE.COM/obs/api/json/RunBackup.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
CancelBackup Boolean This option can be used to cancel a
pending backup job from the server
initiated backup job list. Cannot be used
to stop / cancel an in process (running)
backup job.
BackupType String It must be empty for File, MySQL,
MariaDB, Lotus Notes, System State, MS
Windows Server 2008, MS Exchange Mail
Level Backup, Cloud File, Microsoft 365
Exchange Online, and Linux Bare Metal
backup sets.

For the following Backup Types, this

parameter must be filled with one of the
following:

MS Exchange Server (If VSS supported):

DATABASE
LOG
COPY
DIFFERENTIAL

If not VSS supported:

DATABASE
LOG

www.ahsay.com AhsayCBS API Guide | 386 of 450

 Oracle Database Server Backup, Lotus
Domino, & Tibero Database Server
Backup:
DATABASE
LOG

MS SQL Server Backup:

DATABASE
DIFFERENTIAL
LOG

ShadowProtect System Backup:

COMPLETE
DIFFERENTIAL
INCREMENTAL

MS Hyper-V Backup:
INCREMENTAL
DATABASE

VMware Backup:
VMware ESXi 5.5 / 6 / 6.5 / 6.7 / 7.0 / 8.0
or VMware vCenter 5.5 / 6 / 6.5 / 6.7 /
7.0 / 8.0:
DATABASE
INCREMENTAL

VMware Player 6 / 7 / VMware

Workstation Player 12 / 14 / 15 / 16:
SKIP
POWER-OFF

VMware Workstation 10 / 11 / VMware

Workstation Pro 12 / 14 / 15 /16 or
VMware Fusion 6 / 7 /8 / 10 / 11 / 12
Leave blank

www.ahsay.com AhsayCBS API Guide | 387 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data Array Array list of data
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”username”,
“BackupSetID”:”1462518403716”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 388 of 450

ADDPRECOMMAND
This API can be used to add a pre-backup command to a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Command Line Tool

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddPreCommand.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
Name String Command Name.
WorkingDir String Directory where the command takes
place.
Command String Actual command
Username String If username and password are empty,
add the address without credential.
Password String If username and password are empty,
add the address without credential.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 389 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“Name”:”test”,
“WorkingDir”:”test”,
“Command”:”test”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 390 of 450

UPDATEPRECOMMAND
This API can be used to update a pre-backup command from a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Command Line Tool

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdatePreCommand.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
ID Long Command ID, Obtainable in
GetBackupset API.
Name String Command Name.
WorkingDir String Directory where the command takes
place.
Command String Actual command
Username String If username and password are empty,
add the address without credential.
Password String If username and password are empty,
add the address without credential.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 391 of 450

EXAMPLES

EXAMPLE 1 – UPDATE NAME

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“ID”:”1687755342349”,
“Name”:”newname”
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2 – UPDATE COMMAND CONTENT

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“ID”:”1687755342349”,
“Command”:”newcommand”
}
OUTPUT
{
“Status”:”OK”}

www.ahsay.com AhsayCBS API Guide | 392 of 450

EXAMPLE 3 – UPDATE WORKING DIRECTORY

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“ID”:”1687755342349”,
“WorkingDir”:”newworkingdir”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 393 of 450

REMOVEPRECOMMAND
This API can be used to remove a pre-backup command from a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Command Line Tool

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemovePreCommand.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
ID Long Command ID, Obtainable in
GetBackupset API.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“ID”:”1687755342349”

www.ahsay.com AhsayCBS API Guide | 394 of 450

}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 395 of 450

ADDPOSTCOMMAND
This API can be used to add a post backup command for a backup set.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Command Line Tool

URL
https://CBS.EXAMPLE.COM/obs/api/json/AddPostCommand.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
Name String Command Name.
WorkingDir String Directory where the command takes
place.
Command String Actual command
Username String If username and password are empty,
add the address without credential.
Password String If username and password are empty,
add the address without credential.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 396 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“Name”:”test2”,
“WorkingDir”:”test2”,
“Command”:”test2”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 397 of 450

UPDATEPOSTCOMMAND
This API can be used to update a post-backup command for a backup test.

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

Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > Backup Set
> %Backup Set Name% > Command Line Tool

URL
https://CBS.EXAMPLE.COM/obs/api/json/UpdatePostCommand.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
ID Long Command ID, Obtainable in
GetBackupset API.
Name String Command Name.
WorkingDir String Directory where the command takes
place.
Command String Actual command
Username String If username and password are empty,
add the address without credential.
Password String If username and password are empty,
add the address without credential.

www.ahsay.com AhsayCBS API Guide | 398 of 450

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

EXAMPLES

EXAMPLE 1 – UPDATE NAME

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“ID”:”1687756006432”,
“Name”:”newname”
}
OUTPUT
{
“Status”:”OK”
}

EXAMPLE 2 – UPDATE COMMAND CONTENT

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“ID”:”1687756006432”,
“Command”:”newcommand”
}
OUTPUT
{
“Status”:”OK”}

www.ahsay.com AhsayCBS API Guide | 399 of 450

EXAMPLE 3 – UPDATE WORKING DIRECTORY

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“ID”:”1687756006432”,
“WorkingDir”:”newworkingdir”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 400 of 450

REMOVEPOSTCOMMAND
This API can be used to remove a post-backup command for a backup user.

URL
https://CBS.EXAMPLE.COM/obs/api/json/RemovePostCommand.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
BackupSetID String Obtainable in ListBackupsets API.
ID Long Command ID, Obtainable in
GetBackupset API.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“ID”:”1687756006432”
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 401 of 450

LISTRESTOREJOBS
This API can be used to list all restore jobs of each backup set owned by specified users.

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

Monitoring > Backup / Restore Logs > Restore Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListRestoreJobs.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object See “Data”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

JSON OBJECTS

DATA

KEY TYPE DESCRIPTIONS

BackupSetID String ID of backup set
Removed Boolean Shows whether the backup set is
removed.
RestoreJob Array of String Timestamp (yyyy-MM-dd-HH-mm-ss).

www.ahsay.com AhsayCBS API Guide | 402 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“RestoreJob”:[
“2023-06-26-13-25-13”
],
“BackupSetID”:”1687755057644”,
“Removed”:false
}
]
}

www.ahsay.com AhsayCBS API Guide | 403 of 450

LISTRESTOREJOBSTATUS
This API can be used to list restore job status of a specified user on a particular date.

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

Monitoring > Backup / Restore Logs > Restore Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListRestoreJobStatus.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
Owner String Sub-admin username (if applicable).
LoginName String Client user name.
RestoreDate String In yyyy-MM-dd format.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object See “Data”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 404 of 450

JSON OBJECTS

DATA

KEY TYPE DESCRIPTIONS

ID String ID of Restore Job
LoginName String Client user name.
Owner String Sub admin username (if user owned by
sub admin).
UserId String Unique to each Backup User
StartTime String In yyyy-MM-dd HH:mm:ss format.
EndTime String In yyyy-MM-dd HH:mm:ss format.
RestoreJobStatus String Job status. RESTORE_STOP_SUCCESS if
successful restore.
It varies with the errors found if failed
the restore.
BackupSetID String ID of backup set
BackupSetName String Name of backup set
RestoreSize String Size after restore
RunVersion String Version that ran restore job
SuccessDatabase String Database of successful restore jobs
MissedDatabase String Database of missed restore jobs
SuccessVirtualMachine String If backup is VM type, SuccessPublicFolder
is returned instead.
MissedVirtualMachine String If backup is VM type, MissedPublicFolder
is returned instead.
SuccessPublicFolder String Only returned if backup is VM type.
MissedPublicFolder String Only returned if backup is VM type.
DestinationID String ID of Destination

www.ahsay.com AhsayCBS API Guide | 405 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“RestoreDate”:”2023-06-26”
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“Status”:”RESTORE_STOP_SUCCESS”,
“BackupSetName”:”default-backup-set-name-1”,
“LoginName”:”obm”,
“Owner”:””,
“EndTime”:”2023-06-26 13:25:21”,
“UserId”:”obm”,
“RunVersion”:”9.5.4.0”,
“StartTime”:”2023-06-26 13:25:14”,
“ID”:”2023-06-26-13-25-13”,
“BackupSetID”:”1687755057644”,
“RestoreSize”:0,
“DestinationID”:”1687755083984”
}
]
}

www.ahsay.com AhsayCBS API Guide | 406 of 450

LISTRESTOREDRILLJOBS
This API can be used to list all completed restore drill jobs owned by a specified user.

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

Monitoring > Backup / Restore Logs > Restore Drill Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/ListRestoreDrillJobs.do
AVAILABLE SINCE VERSION:
9.9.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object
Message String Error message, it exists only if status is “Error”.
ExptType String The type of exception, it exists only if status is
“Error”.

JSON OBJECTS

DATA

KEY TYPE DESCRIPTIONS

RestoreDrillJob String Restore Drill Job ID in timestamp (yyyy-MM-dd-HH-
mm-ss) format.
BackupSetID String Backup set ID.
DestinationID String Destination ID.

www.ahsay.com AhsayCBS API Guide | 407 of 450

EXAMPLES

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“RestoreDrillJob”:”2023-10-16-10-28-01”,
“BackupSetID”:”1697422994935”,
“DestinationID”:”1697423083118”
},
{
“RestoreDrillJob”:”2023-10-16-10-30-06”,
“BackupSetID”:”1697422994935”,
“DestinationID”:”1697423083118”
}
]
}

www.ahsay.com AhsayCBS API Guide | 408 of 450

3.3 REPORT

GETBACKUPJOBREPORT
This API can be used to retrieve a detailed report of a specific backup job.

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

Monitoring > Backup / Restore Logs > Backup Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetBackupJobReport.do
AVAILABLE SINCE VERSION:
9.7.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.

To remove multiple users, join their login

names, separated with “ ”.
Owner String To remove multiple users, join their
owner, separated with “ “.
BackupSetID String Obtainable in GetBackupset API.
DestinationID String For backup run by OBM v6 or older, this
parameter can be omitted. For backup
run by OBM 7, this parameter must be
provided to get correct result.
BackupJobID String Obtainable in GetBackupset API.
Cdp Boolean True / False

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object See”JSON Objects”
Message String Error message, it exists only if status is

www.ahsay.com AhsayCBS API Guide | 409 of 450

 "Error".
ExptType String The type of exception, it exists only if
status is "Error".

JSON OBJECTS

REPORT

KEY TYPE DESCRIPTIONS

ID String ID of report
StartTime String In yyyy-MM-dd HH:mm:ss format.
EndTime String In yyyy-MM-dd HH:mm:ss format.
BackupJobStatus String Job status. BS_STOP_SUCCESS if
successful backup.
It varies with the errors found if failed
the bacup.
NumOfWarnEntries Long Number of warning entries
NumOfErrorEntries Long Number of error entries
NumOfNewFiles Long Number of new files
TotalNewFilesSize Long Total size of new files
TotalUnzipNewFilesSize Long Total size of unzipped new files
NewFilesZipRatio Long Ratio of zipped new files
NumOfUpdatedFiles Long Number of updated files
TotalUpdatedFilesSize Long Total size of updated files
TotalUnzipUpdatedFilesSize Long Total size of unzipped updated files
UpdatedFilesZipRatio Long Ratio of zipped updated files
NumOfUpdatedPermissionFiles Long Number of updated permission files
TotalUpdatedPermissionFileSize Long Total size of updated permission files
TotalUnzipUpdatedPermissionFilesSize Long Total size of unzipped updated
permission files
UpdatedPermissionFilesZipRatio Long Ratio of zipped updated permission files
NumOfDeletedFiles Long Number of deleted files
TotalDeletedFilesSize Long Total size of deleted files
TotalUnzipDeletedFilesSize Long Total size of unzipped deleted files
DeletedFilesZipRatio Long Ratio of zipped deleted files
NumOfMovedFiles Long Number of moved files
TotalMovedFilesSize Long Total size of moved files

www.ahsay.com AhsayCBS API Guide | 410 of 450

 TotalUnzipMovedFilesSize Long Total size of unzipped moved files
MovedFilesZipRatio Long Ratio of zipped moved files
SuccessDatabase Long This key does not exist in VM backup.
MissedDatabase Long This key does not exist in VM backup.
SuccessVirtualMachine Long This key exists in VM backup only.
MissedVirtualMachine Long This key exists in VM backup only.
SuccessPublicFolder Long Publif folder of successful jobs
MissedPublicFolder Long Public folder of missed jobs
info Array of InfoLog See “InfoLog”
new Array of FileLog See “FileLog”
upd Array of FileLog See “FileLog”
pmt Array of FileLog See “FileLog”
del Array of FileLog See “FileLog”
mov Array of See “MoveLog”
MoveLog
cpy Array of FileLog See “FileLog”
DedupeEnabled Boolean Enable deduplication.
DedupeOriginalSize Long Size of deduplication.
DedupeSaving Long Difference between the Original Size of
Dedupe and the Current dedupe size.

INFOLOG

KEY TYPE DESCRIPTIONS

Type String Type of log
LogType String Type of log
Timestamp String In yyyy/MM/dd HH:mm:ss format.
Message String Description of log

FILELOG

KEY TYPE DESCRIPTIONS

Type String Type of log
LastModified String In yyyy/MM/dd HH:mm:ss format.
Name String Name of Log
FileSize Long Size of files

www.ahsay.com AhsayCBS API Guide | 411 of 450

UnzipFilesSize Long Size of unzipped files
Ratio String Ratio of files

MOVELOG

KEY TYPE DESCRIPTIONS

Type String Type of log
LastModified String In yyyy/MM/dd HH:mm:ss format.
FromFile String Source file
ToFile String Destination file
FileSize Long Size of file
UnzipFilesSize Long Size of unzipped files
Ratio String Ratio of files

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“Owner”:””,
“BackupSetID”:”1692320086130”,
“DestinationID”:”-1692249670055”,
“BackupJobID”:”2023-0823-10-00-36”,
“Cdp”:”false”
}
OUTPUT
{
“Data”:{
“ID”:”2023-06-26-13-24-35”,
“FromIp”:”10.3.121.64”,
“SuccessDatabase”:””,
“MissedDatabase”:””,
“SuccessPublicFolder”:””,
“MissedPublicFolder”:””,
“Logs”:[
{
“Type”:”start”,
“LogType”:”start”,
“Timestamp”:”2023/06/26 13:24:37”,

www.ahsay.com AhsayCBS API Guide | 412 of 450

 “Message”:”Start [AhsayOBM v 9.5.4.0]”
},
{
“Type”:”info”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 13:24:38”,
“Message”:”Using Temporary Directory

C:\\Users\\Administrator\\temp\\1687755057644\\OBS@1687755083984”
},
{
“Type”:”info”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 13:24:40”,
“Message”:”Index file does not exist in the destination backup
job folder \”null\””
}
],
“NumOfNewFiles”:1169,
“NumOfNewDirCount”:24,
“NumOfNewLinkDirCount”:3,
“NumOfNewLinkFileCount”:0,
“NumOfDeletedDirCount”:0,
“NumOfDeletedLinkFileCount”:0,
“TotalNewFilesSize”:6827033,
“TotalUnzipNewFilesSize”:10268480,
“NewFilesZipRatio”:”33%”,
“NumOfUpdatedFiles”:0,
“TotalUpdatedFilesSize”:0,
“TotalUnzipUpdatedFilesSize”:0,
“UpdatedFilesZipRatio”:”0%”,
“NumOfUpdatedPermissionFiles”:0,
“TotalUpdatedPermissionFileSize”:0,
“TotalUnzipUpdatedPermissionFilesSize”:0,
“UpdatedPermissionFilesZipRatio”:”0%”,
“NumOfDeletedFiles”:0,
“TotalDeletedFilesSize”:0,
“TotalUnzipDeletedFilesSize”:0,
“DeletedFilesZipRatio”:”0%”,
“NumOfMovedFiles”:0,
“TotalMovedFilesSize”:0,
“TotalUnzipMovedFilesSize”:0,
“MovedFilesZipRatio”:”0%”,
“NumOfCopiedFiles”:0,
“TotalCopiedSize”:0,
“TotalUnzipCopiedFilesSize”:0,
“CopiedFilesZipRatio”:”0%”,
“StartTime”:”2023-06-26 13:24:37”,

www.ahsay.com AhsayCBS API Guide | 413 of 450

 “EndTIme”:”2023-06-26 13:24:58”,
“BackupJobStatus”:”BS_STOP_SUCCESS”,
“NumOfWarnEntries”:0,
“NumOfErrorEntries”:0
“DedupeEnabled”:true,
“DedupeOriginalSize”:2384,
“DedupeSaving”:0
},
“Status”:”OK”,
}

www.ahsay.com AhsayCBS API Guide | 414 of 450

GETBACKUPJOBREPORTSUMMARY
This API can be used to retrieve a summary report of a backup job.

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

Monitoring > Backup / Restore Logs > Backup Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetBackupJobReportSummary.do
AVAILABLE SINCE VERSION:
9.7.0.0
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User
with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String
BackupSetID String Obtainable in GetBackupset API.
DestinationID String For backup run by OBM v6 or older, this
parameter can be omitted. For backup
run by OBM 7, this parameter must be
provided to get correct result.
BackupJobID String Obtainable in GetBackupset API.
Cdp Boolean Continuous Data Protection.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 415 of 450

JSON OBJECTS

REPORT

KEY TYPE DESCRIPTIONS

ID String
StartTime String In yyyy-MM-dd HH:mm:ss format.
EndTime String In yyyy-MM-dd HH:mm:ss format.
BackupJobStatus String Job status. BS_STOP_SUCCESS if
successful backup.
It varies with the errors found if failed
the backup.
NumOfWarnEntries Long Number of warning during backup.
NumOfErrorEntries Long Number of error during backup.
NumOfNewFiles Long Number of new files backup.
TotalNewFilesSize Long Total size of new files backup.
NumOfUpdatedFiles Long Number of files updated.
TotalUpdatedFilesSize Long Total size of updated files.
NumOfDeletedFiles Long Number of files deleted.
TotalDeletedFilesSize Long Total size of deleted files.
NumOfMovedFiles Long Number of files moved.
TotalMovedFilesSize Long Total size of moved files.
NumOfUpdatedPermissionFiles Long Number of files permission updated.
TotalUpdatedPermissionFileSize Long Total size of files permission updated.
SuccessDatabase Long This key does not exist in VM backup.
MissedDatabase Long This key does not exist in VM backup.
SuccessVirtualMachine Long This key exists in VM backup only.
MissedVirtualMachine Long This key exists in VM backup only.
SuccessPublicFolder Long
MissedPublicFolder Long
DedupeEnabled Boolean Enable deduplication.
DedupeOriginalSize Long Size of deduplication.
DedupeSaving Long Difference between the Original Size of
Dedupe and the Current dedupe size.

www.ahsay.com AhsayCBS API Guide | 416 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“BackupJobID”:”2023-06-26-13-24-35”,
“DestinationID”:”1687755083984”
}
OUTPUT
{
“Status”:”OK”,
“Data”:{
“TotalCopiedSize”:0,
“DedupeEnabled”:true,
“DedupSaving”:0,
“DedupeOriginalSize”:2384,
“EndTime”:”2023-08-23 10:00:59”,
“TotalDeletdFilesSize”:0,
“NumOfMovedFiles”:0,
“SuccessPublicFolder”:””,
“TotalUpdatedFilesSize”:726,
“TotalUpdatedPermissionFilesSize”:0,
“NumOfWarnEntries”:0,
“NumOfNewFiles”:0,
“NumOfUpdatedFiles”:1,
“NumOfCopiedFiles”:0,
“ID”:”2023-08-23-10-00-36”,
“NumOfErrorEntries”:0,
“BackupJobStatus”:”BS_STOP_SUCCESS”,
“TotalNewFilesSize”:0,
“MissedDatabase”:””,
“NumOfUpdatedPermissionFiles”:0,
“SuccessDatabase”:””,
“StartTime”:”2023-08-23 10:00:37”,
“NumOfDeletedFiles”:0,
“MissedPublicFolder”:””,
“TotalMovedFilesSize”:0
}
}

www.ahsay.com AhsayCBS API Guide | 417 of 450

GETRESTOREJOBREPORT
This API can be used to retrieve a detailed report of a restore job.

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

Monitoring > Backup / Restore Logs > Restore Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetRestoreJobReport.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or API
role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
Owner String Owner of system user (if applicable)
BackupSetID String Obtainable in GetBackupset API.
JobID String ID of restore job. Obtainable from the client restore log or in
the user home at:
%Clientprofile%\.obm\log\%backupset_id%\Restore\YYYY-
MM-DD\YYYY-MM-DD-hh-mm-ss.log
Or
%Userhome%\username\pdf\restore\%backupset_id%\YYYY-
MM-DD\YYYY-MM-DD-hh-mm-ss.pdf
Where the JobID is YYYY-MM-DD -hh-mm-ss (e.g. file name
of the .log / .pdf file).

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object See “JSON Objects”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 418 of 450

JSON OBJECTS

REPORT

KEY TYPE DESCRIPTIONS

ID String ID of report
StartTime Long Start time of restore job
EndTime Long End time of restore job
FromIp String Restore from Ip.
DestinationID String Restore to ID.
Status String This key exists if restore is run by 7 client only.
The value can be one of the following:
RESTORE_STOP_SUCCESS_WITH_ERROR
RESTORE_STOP_SUCCESS_WITH_WARNING
RESTORE_STOP_SUCCESS
RESTORE_STOP_BY_USER
RESTORE_STOP_BY_ERROR
TotalFileCount Long Total file restored.
TotalFileSize Long Total files size restored.
Logs Array of Log Array list of logs

LOG

KEY TYPE DESCRIPTIONS

Type String The value can be one of the following:
file
info
StartTime Long Start time of job
EndTime Long End time of job
Name String Name of job
FileSize Long Size of file
UncompressedSize Long Size of files, uncompressed
LastModified Long Date of last modification
Message String This key exists only if "Type" is "info".
LogType String This key exists only if "Type" is "info".
Timestamp String This key exists only if "Type" is "info".
It is in yyyy/MM/dd hh:mm:ss format.

www.ahsay.com AhsayCBS API Guide | 419 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1687755057644”,
“JobID”:””
}
OUTPUT
{
“Status”:”OK”,
“Data”:{
“Status”:”RESTORE_STOP_SUCCESS”,
“EndTime”:”2023-06-26 14:27:08”,
“TotalFileCount”:0,
“StartTime”:”2023-06-26 14:26:59”,
“TotalFileSize”:0,
“Logs”:[
{
“Type”:”start”
},
{
“Type”:”info”,
“Message”:”Same file \”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_CDP.html\” exists already.”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 14:27:03”
},
{
“Type”:”info”,
“Message”:”Same file\”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_Create_CloudFile_Dest.html\”exists already.”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 14:27:03”
},
{
“Type”:”info”,
“Message”:”Same file \”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_CDP_Filter.html\” exists already.”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 14:27:03”
},
{
“Type”:”info”,
“Message”:”Same file \”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_Create_CloudFile_Source.html\” exists already.”,

www.ahsay.com AhsayCBS API Guide | 420 of 450

 “LogType”:”info”,
“Timestamp”:”2023/06/26 14”27:03”
},
{
“Type”:”info”,
“Message”:”Same file \”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_Create_File_Source.html\” exists already.”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 14:27:03”
},
{
“Type”:”info”,
“Message”:”Same file \”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_Create_IBMDomino_Encryption.html\” exists already.”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 14:27:03”
},
{
“Type”:”info”,
“Message”:”Same file \”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_Create_IBMDomino_Source.html\” exists already.”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 14:27:03”
},
{
“Type”:”info”,
“Message”:”Same file \”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_Create_IBMDomino_WinUserAuthen.html\” exists already.”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 14:27:03”
},
{
“Type”:”info”,
“Message”:”Same file \”C:\\Users\\Administrator\\Desktop\\Help
Files\\ACB\\BS_Create_IBMNotes_Dest.html\” exists already.”,
“LogType”:”info”,
“Timestamp”:”2023/06/26 14:27:03”
}
],
“FromIp”:”10.3.121.64”,
“DestinationID”:”1687755083984”
}
}

www.ahsay.com AhsayCBS API Guide | 421 of 450

GETRESTOREDRILLJOBREPORTSUMMARY
This API can be used to display the summary of specified restore drill job

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

Monitoring > Backup / Restore Logs > Restore Drill Jobs

URL
https://CBS.EXAMPLE.COM/obs/api/json/GetRestoreDrillJobReportSummary.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or
API role.
SysPwd String Password matching SysUser.
LoginName String Client user name.
JobID String Restore drill job ID in timestamp (yyyy-MM-dd-HH-mm-
ss) format. Obtainable in ListRestoreDrillJobs API
BackupSetID String Backup set ID. Obtainable in ListRestoreDrillJobs API.
DestinationID String Destination ID. Obtainable in ListRestoreDrillJobs API.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object See “Data”
Message String Error message, it exists only if status is “Error”.
ExptType String The type of exception, it exists only if status is
“Error”.

www.ahsay.com AhsayCBS API Guide | 422 of 450

JSON OBJECTS

DATA

KEY TYPE DESCRIPTIONS

Status String Job status. SUCCESS if successful restore drill.
It varies with the errors found if the restore drill
failed.
BackupSetID String Backup set ID.
DestinationID String Destination ID.
StartTime Long Start time of the Restore drill job in millisecond time
format.
EndTime Long End time of Restore drill job in millisecond time
format.
LastBackupRun String Verified until this backup job for the backup set.
RunOnClient Boolean Whether backup set is run on client or not.
TotalChunkSize Long Size of total data chunks, in bytes.
TotalChunkCount Long Number of total data chunks.
ValidChunkSize Long Size of data chunks in valid status, in bytes.
ValidChunkCount Long Number of data chunks in valid status.
CorruptedChunkSize Long Size of corrupted data chunks, in bytes.
CorruptedChunkCount Long Number of corrupted data chunks.
ToBeVerifiedChunkSize Long Size of data chunks in unknown status, in bytes.
ToBeVerifiedChunkCount Long Number of data chunks in unknown status.
LogoPath String Path for logo used in PDF reports.
Footer String Footer in PDF reports.

www.ahsay.com AhsayCBS API Guide | 423 of 450

EXAMPLE

EXAMPLE 1

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1686639360356”,
“DestinationID”:”1697505829484”,
“JobID”:”2023-10-17-09-32-47”
}
OUTPUT
{
“Status”:”OK”,
“Data”:{
“Status”:”INVALID_DETECTED”,
“ValidChunkSize”:491185025,
“LogoPath”:”D:\\AhsayCBS\\webapps\\cbs\\images\\default.large.gif”,
“EndTime”:1697506377112,
“LastBackupRun”:”2023-10-17-09-24-12”,
“StartTime”:1697506367000
“CorruptedChunkCount”:120,
“BackupSetID”:”1697505782921”,
“TotalChunkCount”:1913,
“DestinationID”:”1697505829484”,
“RunOnClient”:false,
“ValidChunkCount”:1793,
“ToBeVerifiedChunkSize”:0,
“CorruptedChunkSize”:33432652,
“ToBeVerifiedChunkCount”:0,
“Footer”:”1999-2023 (C) Ahsay Systems Corporation All rights
reserved.”,
“TotalChunkSize”:524617677
}
}

www.ahsay.com AhsayCBS API Guide | 424 of 450

EXAMPLE 2 – INCORRECT DESTINATION ID / BACKUP SET ID

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LoginName”:”obm”,
“BackupSetID”:”1686639360356”,
“DestinationID”:”xxxx”,
“JobID”:”2023-10-17-09-32-47”
}
OUTPUT
{
“Status”:”Error”,
“Message”:”[Error] Restore drill job not found.”,
“ExptType”:”java.lang.Exception
}

www.ahsay.com AhsayCBS API Guide | 425 of 450

4 RPS API
4.1 RPS RECEIVER

LISTRECEIVER
This API can be used to list all the receiver and their settings.

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

Replication > Accepting Data > Receiver

URL
https://CBS.EXAMPLE.COM/rps/api/json/ListReceiver.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or API
role.
SysPwd String Password matching SysUser.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Data JSON Object See “JSON Objects”
Message String Error message, it exists only if status is "Error".
ExptType String The type of exception, it exists only if status is "Error".

www.ahsay.com AhsayCBS API Guide | 426 of 450

JSON OBJECTS

RECEIVER

KEY TYPE DESCRIPTIONS

Id Long ID of receiver
ReplicationEnabled Boolean Replication receiver status.
LoginName String The login name of the replication receiver
account.
Password String The password of the replication receiver.
(‘LoginName’)
Alias String Alias of receiver
ListenPort Integer Listen port (e.g. 9444) of the source backup
server. (applies to v6 only)
ListenHost String Bind to (example “0.0.0.0”) (applies to v6
Replication).
V6ReplicationEnabled Boolean If v6 Replication setting is enabled or not.
SystemHome String The Replication System Home path (“Default
Home Directory”) for this replication receiver.
RestoreRunning Boolean Restore the replication snapshot.
TrafficLimits Array of Limit the usage of network bandwidth by the
TrafficLimit replication service.
UserHomeMappings Array of The source backup server user home location.
UserHomeMapping
RestoringPath String Path of restore
IPRestrictions Array of This is to restrict the range of IP to access this
IPRestriction receiver.
RestoreStatus String Restore job status
ObsHost String Backup Server host (FQDN)
ObsProtocol String HTTP or HTTPS
ObsSysUser String The system user login of the backup server,
stored when Add New Receiver.
ObsSysPwd String The system user password login of the backup
server.
ObsPort Integer The backup server connector port.
ObsVersion Integer Integer of 0 = v6 Sender (“Before V7=Yes” in
the CBS UI), 1 = v7+
RestorePointInterval Integer Value for the Replication Retention Setting.
RetentionCustomizationPolicy Integer Value for the Replication Retention Setting.

www.ahsay.com AhsayCBS API Guide | 427 of 450

 CrcEnabled Boolean Cyclic Redundancy Check (CRC) Checking.
(applies to v6 Replication)
CrcHour Integer Monthly at HH:MM (applies to v6 Replication)
CrcMinute Integer Monthly at HH:MM (applies to v6 Replication)

TRAFFICLIMIT

KEY TYPE DESCRIPTIONS

ID Long ID of limit
Name String Label name
Always Boolean If True, MaxTransferRate is always applied
regardless of time.
FromDayOfWeek Integer 0 = Sunday, 6 = Friday
FromHour Integer In 24-hour format
FromMin Integer In 60-minute format
ToDayOfWeek Integer 0 = Sunday, 6 = Friday
ToHour Integer In 24-hour format
ToMin Integer In 60-minute format
MaxTransferRate Long In Bytes

USERHOMEMAPPING

KEY TYPE DESCRIPTIONS

RPSDir String Replication Home
OBSHome String Backup Server User Home

IPRESTRICTION

KEY TYPE DESCRIPTIONS

Id Long ID of restriction
From String IP Address
To String IP Address

www.ahsay.com AhsayCBS API Guide | 428 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”
}
OUTPUT
{
“Status”:”OK”,
“Data”:[
{
“UserHomeMappings”:[
{
“RPSDir”:”F:\\rcvr”,
“OBSHome”:”C:\\Program Files\\AhsayOBS and AhsayRPS\\user”
}
],
“ObsPort”:80,
“MidButtons”:[],
“LoginName”:”rcvr”,
“MigrateFromV6”:false,
“LatestSnapshot”:”2023-06-29-10-48-19”,
“RestoringPath”:””,
“Classname”:”com.ahsay.cbs.rps.config.receiver.EditRecevierBean”,
“ObsProtocol”:”http”,
“RestoreRunning”:false,
“Update”:false,
“RestoreStatus”:””,
“Update”:false,
“ListenHost”:”0.0.0.0”,
“TrafficLimits”:[],
“V6ReplicationEnabled”:false,
“ObsSysPwd”:”system1”,
“SystemHome”:”C:\\Program
Files\\AhsayCBS\\system\\rps\\rcvshome\\rcvr”,
“RestorePointInterval”:30,
“RightButton”:[
{
“Trigger”:{},
“OpenNewFrame”:true,
“ReadPrivilege”:””,
“ImageURL”:”images/btn_ico_ok_72.png”,
“Style”:””,
“DynamicLabel”:””,
“WritePrivilege”:””,
“LabelRes”:”com.ahsay.atl.jsp.LabelInfo.OK”,

www.ahsay.com AhsayCBS API Guide | 429 of 450

 “ReadPrivileges”:””
},
{
“Trigger”:{},
“OpenNewFrame”:true,
“ReadPrivilege”:””,
“ImageURL”:”images/btn_ico_cancel_72.png”,
“Style”:””,
“DynamicLabel”:””,
“WritePrivilege”:””,
“LabelRes”:”com.ahsay.atl.jsp.LabelInfo.Cancel”,
“ReadPrivilege”:””
},
{
“Trigger”:{},
“OpenNewFrame”:true,
“ReadPrivilege”:””,
“ImageURL”:”images/btn_ico_help_72.png”,
“Style”:””,
“DynamicLabel”:””,
“WritePrivilege”:””,
“LabelRes”:”com.ahsay.atl.jsp.LabelInfo.Help”,
“ReadPrivileges”:””
}
],
“BlockCount”:0,
“ObsHost”:”10.3.121.64”,
“ProgressInfo”:{},
“ObsSysUser”:”system”,
“LeftButtons”:[],
“RetentionCustomizationPolicy”:60,
“Password”:”rcvr1”,
“RestoreDir”:””,
“RestoreDisableStop”:false,
“CrcEnabled”:false,
“IPRestrictions”:[].
“CrcHour”:0,
“ObsVersion”:1,
“TrafficLimit”:{},
“ListenPort”:9444,
“CrcMinute”:0,
“Alias”:”rcvr”,
“Tabs”:[],
“Id”:1,
“ReplicationEnabled”:true
}
]
}

www.ahsay.com AhsayCBS API Guide | 430 of 450

UPDATERECEIVERS
This API can be used to update settings of an existing replication receiver setting. You should
use ListReceiver.do to obtain the current values, to pass back values to keep along with your
changes, UpdateReceivers.do is designed as overwrite mode.

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

Replication > Accepting Data > Receiver

URL
https://CBS.EXAMPLE.COM/rps/api/json/UpdateReceivers.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with
Admin or API role.
SysPwd String Password matching SysUser.
Id Long Use ListReceiver.do to obtain the response
output from existing ‘Id’, then pass it back using
UpdateReceivers.do with your changes.
Note: If ‘Id’ value is 0, a new receiver is created.
This is experimental.
Note: If ‘Id’ value does not exist as a Receiver ID,
you may corrupt your CBS Receiver UI.
ReplicationEnabled Boolean Enable replication of the receiver.
LoginName String The login name of the replication receiver
account.
Password String The password of the replication receiver.
Alias String Alias of receiver
ListenPort Integer Listen port (e.g. 9444) of the source backup
server. (applies to v6 only)
ListenHost String Bind to (example “0.0.0.0”) (applies to v6
Replication)
SystemHome String The Replication System Home path (“Default
Home Directory”) for this replication receiver ID.
RestoreRunning Boolean Restore the replication snapshot.
TrafficLimits Array of Limit the usage of network bandwidth by the
TrafficLimit replication service.
UserHomeMappings Array of The source backup server user home location.

www.ahsay.com AhsayCBS API Guide | 431 of 450

 UserHomeMapping
RestoringPath String Path of Restore
IPRestrictions Array of This is to restrict the range of IP to access this
IPRestriction receiver.
RestoreStatus String Status of restore
ObsVersion Integer Integer of 0 = v6 Sender (“Before V7=Yes” in the
CBS UI), 1 = v7+
ObsHost String Backup Server host (FQDN)
ObsProtocol String http or https
ObsSysUser String The system user login of the backup server.
ObsSysPwd String The system user password login of the backup
server.
ObsPort Integer Port number complimentary to the
“ObsProtocol”.
RestorePointInterval Integer Value for the Replication Retention Setting.
RetentionCustomizationPolicy Integer Value for the Replication Retention Setting.
CrcEnabled Boolean Cyclic Redundancy Check (CRC) Checking.
(applies to v6 Replication)
CrcHour Integer Monthly at HH:MM (applies to v6 Replication)
CrcMinute Integer Monthly at HH:MM (applies to v6 Replication)
MigrateFromV6 Boolean
V6ReplicationEnabled Boolean If v6 Replication setting is enabled, then also
pass ListenPort and ListenHost Keys.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 432 of 450

JSON OBJECTS

TRAFFICLIMIT

KEY TYPE DESCRIPTIONS

ID Long ID of receiver
Name String Name of receiver
Always Boolean If True, MaxTransferRate is always
applied regardless of time.
FromDayOfWeek Integer 0 = Sunday, 6 = Friday
FromHour Integer In 24-hour format
FromMin Integer In 60-minute format
ToDayOfWeek Integer 0 = Sunday, 6 = Friday
ToHour Integer In 24-hour format
ToMin Integer In 60-minute format
MaxTransferRate Long In Bytes

USERHOMEMAPPING

KEY TYPE DESCRIPTIONS

RPSDir String Replication Home
OBSHome String Backup Server User Home

IPRESTRICTION

KEY TYPE DESCRIPTIONS

ID Long ID of restriction
From String IP Address
To String IP Address

www.ahsay.com AhsayCBS API Guide | 433 of 450

EXAMPLES

EXAMPLE 1 – ENABLE REPLICATION

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Id”:0,
“ReplicationEnabled”:true,
“LoginName”:”rcvr”,
“Password”:”rcvr1”,
“Alias”:”rcvr”,
“ObsProtocol”:”https”,
“ObsHost”:”rcvr.com”,
“ObsPort”:”443”,
“ObsVersion”:1,
“ObsSysUser”:”system”,
“ObsSysPwd”:”system1”,
“V6ReplicationEnabled”:false,
“MigrateFromV6”:false,
“ListenHost”:”0.0.0.0”,
“ListenPort”:9444,
“CrcEnabled”:false,
“CrcHour”:0,
“CrcMinute”:0,
“RestorePointInterval”:30,
“RetentionCustomizationPolicy”:60,
“SystemHome”:”C:\\Program Files\\AhsayCBS\\system\\rps\\rcvshome\\rcvr”,
“UserHomeMappings”:[
{
“RPSDir”:”F:\\rcvr”,
“OBSHome”:”C:\\Program Files\\AhsayCBS\\user”
},
],
“IPRestrictions”:[],
“TrafficLimits”:[]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 434 of 450

EXAMPLE 2 – DISABLE REPLICATION

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Id”:0,
“ReplicationEnabled”:false,
“LoginName”:”rcvr”,
“Password”:”rcvr1”,
“Alias”:”rcvr”,
“ObsProtocol”:”https”,
“ObsHost”:”rcvr.com”,
“ObsPort”:”443”,
“ObsVersion”:1,
“ObsSysUser”:”system”,
“ObsSysPwd”:”system1”,
“V6ReplicationEnabled”:false,
“MigrateFromV6”:false,
“ListenHost”:”0.0.0.0”,
“ListenPort”:9444,
“CrcEnabled”:false,
“CrcHour”:0,
“CrcMinute”:0,
“RestorePointInterval”:30,
“RetentionCustomizationPolicy”:60,
“SystemHome”:”C:\\Program Files\\AhsayCBS\\system\\rps\\rcvshome\\rcvr”,
“UserHomeMappings”:[
{
“RPSDir”:”F:\\rcvr”,
“OBSHome”:”C:\\Program Files\\AhsayCBS\\user”
},
],
“IPRestrictions”:[],
“TrafficLimits”:[]
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 435 of 450

REMOVERECEIVER
This API can be used to remove a replication receiver, and may help to remove when the GUI
cannot.

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

Replication > Accepting Data > Receiver

URL
https://CBS.EXAMPLE.COM/rps/api/json/RemoveReceiver.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or API
role.
SysPwd String Password matching SysUser.
Id Long Use ListReceiver.do to obtain the response output from
existing ‘Id’, then pass it back using UpdateReceivers.do
with your changes.
Note: If ‘Id’ value is 0, a new receiver is created. This is
experimental.
Note: If ‘Id’ value does not exist as a Receiver ID, you may
corrupt your CBS Receiver UI.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is "Error".
ExptType String The type of exception, it exists only if status is "Error".

www.ahsay.com AhsayCBS API Guide | 436 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“Id”:”1”,
}
OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 437 of 450

5 RDR API
5.1 RDR LICENSE

UPDATELICENSE
This API can be used to update the licensee name and license key on the AhsayCBS server for
the redirector.

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

System Settings > License > Redirector

URL
https://CBS.EXAMPLE.COM/rdr/api/json/UpdateLicense.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or API
role.
SysPwd String Password matching SysUser.
LicenseeName String Licensee name of redirector key.
LicenseKey String Product Key for redirector.
UseProxy Boolean Enable / Disable the use of proxy defined in AhsayCBS to
connect the internet.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 438 of 450

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“LicenseeName”:”Ahsay_Test_RDR”,
“LicenseKey”:”qwerty-5jjM4+Sz-SCz68XG+J”
}
OUTPUT 1
{
“Status”:”OK”,
“Key”:”qwerty-5jjM4+Sz-SCz68XG+J”,
“Deactivated”:false,
“Licensee”:”Ahsay_Test_RDR”
}
OUTPUT 2
{
“Status”:”OK”,
“Key”:”qwerty-5jjM4+Sz-SCz68XG+J”,
“Deactivated”:false,
“Info”:”Internal Error 1012. Please press the [Update] button in license
page to correct this problem. If the problem persists, please contact our
technical support team to resolve this problem.”,
“Licensee”:”Ahsay_Test_RDR”
}
OUTPUT 3
{
“Status”:”Error”,
“Message”:”License key incorrect. Please try again.”
}
OUTPUT 4
{
“Status”:”OK”,
“Key”:”qwerty-5jjM4+Sz-SCz68XG+J”,
“Deactivated”:false,
“Info”:”[OEM Liccense.checkLicTime] License expired on 1970-01-01.
Backup server is stopped”,
“Licensee”:”Ahsay_Test_RDR”
}

www.ahsay.com AhsayCBS API Guide | 439 of 450

5.2 SERVER CONFIG

UPDATESERVERCONFIG
This API can be used to update the Redirector module’s setting.

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

Redirection > Hosting a redirector > Server Configuration

URL
https://CBS.EXAMPLE.COM/rdr/api/json/UpdateServerConfig.do
AVAILABLE SINCE VERSION:
9.1
PARAMETERS
KEY TYPE DESCRIPTIONS
SysUser String Username of an AhsayCBS System User with Admin or API
role.
SysPwd String Password matching SysUser.
SkipDuplicateUserCheck Boolean Do not check duplicate users.
BackupServers Array Redirector will redirect user to these backup servers.
EnableRdr Boolean True / False
FreeTrialServer Integer ID of the backup server for free trial registration.

RETURN VALUES

KEY TYPE DESCRIPTIONS

Status String “OK” or “Error”
Message String Error message, it exists only if status is
"Error".
ExptType String The type of exception, it exists only if
status is "Error".

www.ahsay.com AhsayCBS API Guide | 440 of 450

JSON OBJECTS

BACKUP SERVERS

KEY TYPE DESCRIPTIONS

ID Long ID of config
Enabled Boolean True / False
HttpEnabled Boolean True / False
SslEnabled Boolean True / False
LoginName String Login name used for backup server
Password String Password used for backup server
Hostname String Hostname or IP address
HttpPort Integer Port used by backup server
SslPort Integer SSL port used by backup server
Class String The value must be
"com.ahsay.cbs.rdr.config.system.
EditServerConfigBean$BackupServerBean".

EXAMPLE

INPUT
{
“SysUser”:”system”,
“SysPwd”:”system1”,
“BackupServers”:[
{
“Id”:”1”,
“Enabled”:true,
“HttpEnabled”:false,
“SslEnabled”:true,
“LoginName”:”system”,
“Password”:”system1”,
“Hostname”:”rcvr.com”,
“HttpPort”:80,
“SslPort”:443,

“Class”:”com.ahsay.cbs.rdr.config.system.EditServerConfigBean$BackupServerBean”
}
],
“SkipDuplicateUserCheck”:false,
“EnabledRdrFreeTrial”:true
}

www.ahsay.com AhsayCBS API Guide | 441 of 450

OUTPUT
{
“Status”:”OK”
}

www.ahsay.com AhsayCBS API Guide | 442 of 450

CONTACT AHSAY
SUPPORT
You can contact Ahsay support representatives on the following touchpoints:

Through the Partner Portal

WhatsApp, found in the website

DOCUMENTATION
For additional resources, you can find articles published in https://wiki.ahsay.com.

Available guides for all Ahsay products are available at: Administrator and User Guides

www.ahsay.com AhsayCBS API Guide | 443 of 450

APPENDIX – OVERVIEW
CONVENTIONS
List of notations used throughout this document:
Convention Descriptions Example
Bold Important Information WARNING: Text
[] Graphical Interface Elements [Manage Log]
%% Filepath in Windows format %CBS_HOME%

$ Filepath in Linux/Unix/BSD format $CBS_Home

Notations that are used specifically for API sections:

Convention Descriptions
<Text inside angle brackets> Placeholder for which you must supply a value.
or Red
[Text inside square brackets] Optional items.
{Text inside braces} Set of required items, choose one.
Vertical bar ( | ) Separator for mutually exclusive items, choose one.
Ellipsis ( … ) Items that can be repeated.
Bold All the keys defined in the parameter section or the JSON objects are
mandatory.

The API or parameters are available (updated) since the version shown for each API.

www.ahsay.com AhsayCBS API Guide | 444 of 450

DEFINITIONS, ACRONYMS, AND ABBREVIATIONS

Term/Abbreviation Descriptions
AhsayCBS Ahsay™ Cloud Backup Suite
AhsayOBM Ahsay™ Online Backup Manager
AhsayACB Ahsay™ A-Click Backup
CBS_HOME The install location of AhsayCBS.
Windows
C:\Program Files\AhsayCBS
Linux
/usr/local/cbs
CONF_HOME The directory to store AhsayCBS configuration files.
Windows
%CBS_HOME%\conf
Linux
$CBS_HOME/conf
USER_HOME The directories where AhsayCBS store the AhsayOBM & AhsayACB
users accounts.
The default location is:
%CBS_HOME%/users
POLICY_HOME The directory where AhsayCBS store its system users and group policy
information.
Windows
%CBS_HOME%\system\policy
Linux
$CBS_HOME/system/policy
SYSTEM_HOME The directory where AhsayCBS store its system information.
Windows
%CBS_HOME%\system\
Linux
%CBS_HOME/system
WEBAPPS_HOME Location of the webapps directory inside the installation directory of
AhsayCBS.
Windows
%CBS_HOME%\webapps
Linux
$CBS_HOME/webapps
RECEIVER_HOME The location where the replicated data is stored for a particular
replication receiver.
JAVA_HOME The location where JAVA is installed.

www.ahsay.com AhsayCBS API Guide | 445 of 450

SUPPORTED LANGUAGE CODE

Language Code Language

ar Arabic
ca Catalan
cs Czech
da Danish
de German
el Greek Modern
en English
es Spanish
eu Euskara/Basque
fi Finnish
fr French
iw Hebrew
hu Hungarian
id Indonesian
it Italian
ja Japanese
ko Korean
lt Lithuanian
nl Dutch
no Norwegian
pl Polish
pt_BR Portuguese (Brazil)
pt_PT Portuguese (Portugal)
ro Russian
sl Slovenian
sv Swedish
th Thai
tr Turkish
vi Vietnamese
zh_CN Chinese (Simplified)
zh_TW Chinese (Traditional)

www.ahsay.com AhsayCBS API Guide | 446 of 450

SUPPORTED TIMEZONES

Timezone String ID Timezone Names

GMT+13:00 (WST) 1001 Western European Summer Time
GMT-11:00 (NUT) 1002 Niue Time
GMT-11:00 (SST) 1003 Samoa Standard Time
GMT-10:00 (HADT) 1004 Hawaii-Aleutian Daylight Time
GMT-10:00 (HST) 1005 Hawaiian Standard Time
GMT+13:00 (TKT) 1006 Tokelau Time
GMT-10:00 (HST) 1007 Hawaii Standard Time
GMT-10:00 (CKT) 1008 Cook Islands Time
GMT-10:00 (TAHT) 1009 Tahiti Time
GMT-09:00 (AKDT) 1010 Alaska Standard Time
GMT-09:00 (GAMT) 1011 Gambier Time
GMT-08:00 (PST) 1012 Pacific Standard Time (North America)
GMT-08:00 (PDT) 1013 Pacific Daylight Time (North America)
GMT-07:00 (MST) 1014 Mountain Standard Time
GMT-07:00 (MDT) 1015 Mountain Daylight Time
GMT-06:00 (CST) 1016 Central Standard Time
GMT-06:00 (EAST) 1018 Easter Island Time
GMT-06:00 (GALT) 1019 Galapagos Time
GMT-05:00 (EST) 1020 Eastern Standard Time (North America)
GMT-04:00 (EDT) 1021 Eastern Daylight Time
GMT-05:00 (COT) 1022 Colombia Time
GMT-05:00 (ECT) 1023 Ecuador Time
GMT-05:00 (CDT) 1024 Central Daylight Time (North America)
GMT-05:00 (PET) 1025 Peru Time
GMT-04:00 (ACT) 1026 Acre Time
GMT-05:00 (GMT-05:00) 1027
GMT-04:00 (AST) 1028 Atlantic Standard Time
GMT-04:00 (PYT) 1029 Paraguay Time
GMT-04:30 (VET) 1030 Venezuela Time
GMT-04:00 (AMT) 1031 Armenia Time
GMT-04:00 (GYT) 1032 Guyana Time
GMT-04:00 (ADT) 1033 Acre Daylight Time Atlantic Standard
Time

www.ahsay.com AhsayCBS API Guide | 447 of 450

GMT-04:00 (BOT) 1034 Bolivia Time
GMT-04:00 (AMT) 1035 Armenia Time
GMT-04:00 (CLT) 1036 Chile Time
GMT-03:00 (FKT) 1037 Falkland Islands
GMT-03:00 (ART) 1038 Argentina Time
GMT-03:00 (GFT) 1039 Guiana Time
GMT-03:00 (BRT) 1040 Brasilia Time
GMT-03:00 (WGST) 1041 West Greenland Summer Time
GMT-03:00 (PMDT) 1042 Pierre & Miquelon Daylight Time
GMT-03:00 (UYT) 1043 Uruguay Time
GMT-03:00 (SRT) 1044 Suriname Time
GMT-02:00 (FNT) 1045 Fernando de Noronha Time
GMT-02:00 (GST) 1046 Gulf Standard Time
GMT-01:00 (EGST) 1047 East Greenland Summer Time
GMT-01:00 (AZOST) 1048 Azores Summer Time
GMT-01:00 (CVT) 1049 CAPE VERDE TIME
GMT-01:00 (EGT) 1050 EAST GREENLAND TIME
GMT+00:00 (GMT) 1051 Greenwich Mean Time
GMT+00:00 (WET) 1052 Western European Time
GMT+00:00 (WEST) 1053 Western European Summer Time
GMT+00:00 (IST) 1054 Israel Standard Time
GMT+00:00 (BST) 1055 Brazil Standard Time
GMT+00:00 (UTC) 1056 Coordinate Universal Time
GMT+01:00 (CET) 1057 Central European Time
GMT+01:00 (WAT) 1058 West Africa Time
GMT+02:00 (CEST) 1059 CENTRAL EUROPEAN SUMMER TIME
GMT+02:00 (EEST) 1060 Eastern European Summer Time
GMT+02:00 (CAT) 1061 Central Africa Time
GMT+02:00 (SAST) 1062 South African Standard Time
GMT+02:00 (EET) 1063 Eastern European Time
GMT+02:00 (IDT) 1064 Israel Daylight Time
GMT+03:00 (EAT) 1065 East Africa Time
GMT+03:00 (AST) 1066 Acre Standard Time
GMT+03:00 (ADT) 1067 Acre Daylight Time
GMT+04:00 (MSD) 1068 Moscow Daylight Time
GMT+05:00 (AQTST) 1069 Aqtau Summer Time

www.ahsay.com AhsayCBS API Guide | 448 of 450

GMT+04:00 (AZST) 1070 Azerbaijan Summer Time
GMT+04:00 (GST) 1071 Gulf Standard Time
GMT+04:00 (GEST) 1072 Georgia Time
GMT+04:00 (AMST) 1073 Armenia Summer Time
GMT+04:00 (SAMST) 1074 Samara Time
GMT+04:00 (SCT) 1075 Seychelles Time
GMT+04:00 (MUT) 1076 Mauritius Time
GMT+04:00 (RET) 1077 Reunion Time
GMT+05:00 (TMT) 1078 Turkmenistan Time
GMT+06:00 (KGST) 1079 Kyrgyzstan Summer Time
GMT+05:00 (TJT) 1080 Tajikistan Time
GMT+05:00 (PKT) 1081 Pakistan Time
GMT+05:00 (UZT) 1082 Uzbekistan Time
GMT+06:00 (YEKST) 1083 Yekaterinburg Summer Time
GMT+06:00 (IOT) 1084 Indian Ocean Territory Time
GMT+05:00 (TFT) 1085 French Southern & Antarctic Lands Time
GMT+05:00 (MVT) 1086 Maldives Time
GMT+05:00 (MAWT) 1087 Mawson Time
GMT+06:00 (ALMST) 1088 Almaty Summer Time
GMT+05:30 (LKT) 1089 Sri Lanka Time
GMT+06:00 (BDT) 1090 Bangladesh Time
GMT+07:00 (NOVT) 1091 Novosibirsk Time
GMT+06:00 (BTT) 1092 Bhutan Time
GMT+07:00 (ICT) 1093 Indochina Time
GMT+07:00 (JAVT) 1094 Java Time, Indonesia Time
GMT+08:00 (KRAT) 1095 Krasnoyarsk Time
GMT+07:00 (CXT) 1096 Christmas Island Time
GMT+08:00 (HKT) 1097 Hong Kong Time
GMT+08:00 (CST) 1098 Central Standard Time
GMT+08:00 (BNT) 1099 Brunei Darussalam Time
GMT+08:00 (WST) 1100 West Samoa Time
GMT+09:00 (IRKST) 1101 Irkutsk Summer Time
GMT+08:00 (MYT) 1102 Malaysia Time
GMT+08:00 (PHT) 1103 Philippine Time
GMT+08:00 (SGT) 1104 Singapore Time
GMT+08:00 (BORT) 1105 Borneo Time

www.ahsay.com AhsayCBS API Guide | 449 of 450

GMT+08:00 (ULAT) 1106 Ulan Bator Time
GMT+09:00 (JAYT) 1107 Jayapura Time
GMT+09:00 (KST) 1108 Korean Standard Time
GMT+09:00 (JST) 1109 Japan Standard Time
GMT+10:00 (YAKT) 1110 Yakutsk Time
GMT+09:00 (PWT) 1111 Palau Time
GMT+10:00 (EST) 1112 Australia Eastern Standard Time
GMT+10:00 (DDUT) 1113 Dumont-d’Urville Time
GMT+11:00 (VLAT) 1114 Vladivostok Time
GMT+10:00 (ChST) 1115 Chamorro Standard Time
GMT+10:00 (PGT) 1116 Papua New Guinea Time
GMT+10:00 (TRUT) 1117 Truk Time
GMT+12:00 (MAGT) 1118 Magadan Time
GMT+11:00 (VUT) 1119 Vanuatu Time
GMT+11:00 (SBT) 1120 Solomon Islands Time
GMT+11:00 (KOST) 1121 Kosrae Time
GMT+11:00 (NCT) 1122 New Caledonia Time
GMT+11:00 (PONT) 1123 Ponape Time
GMT+12:00 (NZST) 1124 New Zealand Standard Time
GMT+12:00 (ANAST) 1125 Anadyr Time
GMT+12:00 (PETST) 1126 Petropavlovsk-Kamchatski Time
GMT+12:00 (FJT) 1127 Fiji Time
GMT+12:00 (TVT) 1128 Tuvalu Time
GMT+12:00 (MHT) 1129 Marshall Islands Time
GMT+12:00 (NRT) 1130 Nauru Time
GMT+12:00 (GILT) 1131 Gilbert Island Time
GMT+12:00 (WAKT) 1132 Wake Time
GMT+12:00 (WFT) 1133 Wallis and Futuna Time
GMT+08:00 (CST) 1134 Cuba Standard Time
GMT+03:30 (IRST) 1135 Iran Standard Time
GMT+05:30 (IST) 1136 India Standard Time
GMT-03:30 (NST) 1137 Newfoundland Standard Time (NST)
GMT-03:00 (BET) 1138 Brazil Eastern Time

www.ahsay.com AhsayCBS API Guide | 450 of 450