Versions Compared

Old Version 259

changes.mady.by.user Alexey Turchanikov

Saved on

compared with

New Version 260

changes.mady.by.user Andrey Vovk

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

All production endpoints have their version on sandbox with changed domain names:

...

  • uncancel  entities in hierarchy 

  • uncancel  direct backup accounts

  • uncancel  backup accounts  in hierarchy 

  • return revoked licences 

  • so on

Also take note that system cleanups data hold by cancelled accounts & entities after some grace period. For instance, backed up files are automatically deleted in about 3 month, used licences usually get deactivated in about 7 days,  unused licences get transferred to parent entity immediately  and so on.  Uncancel operation won't  revert any of those  or similar  purge actions those already partially or fully completed by the date of uncancel. It only marks entity as active and allows you to reuse it again.

Input request fields:

Parameter

Description

Validation

TargetEntityId

ID of the Partner/Company to uncancel

Int > 0 , Caller cannot uncancel himself.

...

Parameter

Description

Validation

UserName

Login name for dashboard user. 

Required, "^(?!^\d+(WS|Ws|wS|ws|FL|Fl|fL|fl)$)(?!^(U|u)\d+$)[a-zA-Z0-9@\._-]{3,50}$"

Password

Password of the dashboard user

Required, "^[a-zA-Z0-9!@#$%^&*()]{6,20}$"


Request example:


Code Block
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sos="sosonlinebackup.com">
   <soap:Header>
      <sos:AuthHeader>
         <sos:UserName>A****</sos:UserName>
         <sos:Password>V*****</sos:Password>
      </sos:AuthHeader>
   </soap:Header>
   <soap:Body>
      <sos:AuthenticateDashboardUser>
         <sos:request>
            <sos:UserName>Dan*****</sos:UserName>
            <sos:Password>tf****</sos:Password>
         </sos:request>
      </sos:AuthenticateDashboardUser>
   </soap:Body>
</soap:Envelope>

...

Parameter

Description

Validation

PartnerName

Non-unique identifier of partner. Max 50 characters according to the regular expression provided.

Required,"^[a-zA-Z0-9]([a-zA-Z0-9\.-_\s&]){0,48}([a-zA-Z0-9\.]){1}$"

GeneralContactPerson

Name of contact person

Required, "^[a-zA-Z]([a-zA-Z\.-]|\s){1,49}$"

GeneralContactEmail

Email

Required, "^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9_-]+)*\.([a-zA-Z]{2,}){1,49}$"

DiskQuotaGB

Storage quota for partner

Integer >= 1

AllowUploadOverAccountSize


Bool

AutoUpgradeClientApp

Indicates if all accounts of new partner will use automatic update of client software

bool , Optional, false if missed

SendResetPasswordEmail

 If true, email with reset password link is sent to user.

See details about reset password link in SendResetPasswordLink method description

bool , Optional, false if missed

...

https://dashboard.managedoffsitebackup.net/EmailTemplate (template with code "EntityResetPwd")

...

By default, for security sake, dashboard user name is not sent in email.

...

Parameter

Description

Validation

TargetEntityID

ID of the Partner/Company/Distributor where new administrator is needed

Int, >=0. Use 0 for yourself.

UserName

Login name for dashboard. Names like 2222WS, 2222FL and U2222 are forbidden here.

Required, "^(?!^\d+(WS|Ws|wS|ws|FL|Fl|fL|fl)$)(?!^(U|u)\d+$)[a-zA-Z0-9@\._-]{3,50}$"

Password

Password, leave it empty if you want system to generate it

Optional, "^[a-zA-Z0-9!@#$%^&*()]{6,20}$"

Returns generated password and standard Result object. Can return following custom result codes.

...

Operation: CancelEmptyPartner  

Sandbox:    https://secure-sandbox.sosonlinebackup.com/WebApi/AccountManagementService/PartnerManagementService.asmx?op=CancelEmptyPartner

...

Parameter

Description

Validation

TargetEntityId

ID of the parent Partner

Required, integer

CompanyName


Required,"^[a-zA-Z0-9]([a-zA-Z0-9\.-_\s&]){0,48}([a-zA-Z0-9\.]){1}$"

GeneralContactPerson

Name of contact person

Required, "^[a-zA-Z]([a-zA-Z\.-]|\s){1,49}$"

GeneralContactEmail

Email

Required, "^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9_-]+)*\.([a-zA-Z]{2,}){1,49}$"

DiskQuotaGB

Storage quota for company

Integer >= 1

AllowUploadOverAccountSize


Bool

DataCenterCountryCodeIsoA2

ISO 3166-1 two-letter country code (alpha-2) 

Optional, string, can be empty.

Now available data centers in following countries:

US - UNITED STATES

GB -UNITED KINGDOM

AU -AUSTRALIA

CA -CANADA

ZA -SOUTH AFRICA

DE -GERMAN

If not set or empty, when backup account is created for company, backup server will be selected automatically.

If parameter is correct country code, all backup accounts of this entity will persist data in scope of data centers restricted by region of specific country.

If parameter is correct country code, but there are no data centers in that country, error is fired ( err-code: CannotFindDataCenterForCountry)

If parameter is not correct ISO 3166-1 two-letter country code,error is fired( err-code: InvalidInputParameters)

Availability of non US backup servers should be discussed during sales by dedicated request to Account Manager

AutoUpgradeClientApp

Indicates if all accounts of new company will use automatic update of client software

bool , Optional, false if missed

Code Block
DisableEmailsNotification

Allow to disable sending all emails notifications

bool , Optional, false if missed

...

Parameter

Description

Validation

CompanyName


Required,"^[a-zA-Z0-9]([a-zA-Z0-9\.-_\s&]){0,48}([a-zA-Z0-9\.]){1}$"

TargetEntityId

 ID of the parent Partner

Required, integer

DiskQuotaGB

Storage quota for company

Integer >= 1

Code Block
BackupAccountUserFullName


Required, "^[a-zA-Z]([a-zA-Z\.-]|\s){1,30}$"

Code Block
BackupAccountUserName


Required, "^[^<>]{0,100}$"

Code Block
BackupAccountPassword


Required, "^[a-zA-Z0-9!@#$%^&*()]{6,20}$"

Code Block
IsBackupAccountUltraSafe

Standard or Ultrasafe security

Bool

Code Block
BackupAccountEmail


Required, "^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9_-]+)*\.([a-zA-Z]{2,}){1,49}$"

Code Block
AllowUploadOverAccountSize


Bool

DataCenterCountryCodeIsoA2

ISO 3166-1 two-letter country code (alpha-2) 

Optional, string, can be empty.

Now available data centers in following countries:

US - UNITED STATES

GB -UNITED KINGDOM

AU -AUSTRALIA

CA -CANADA

ZA -SOUTH AFRICA

If not set or empty, when backup account is created for company, backup server will be selected automatically.

If parameter is correct country code, all backup accounts of this entity will persist data in scope of data centers restricted by region of specific country.

If parameter is correct country code, but there are no data centers in that country, error is fired ( err-code: CannotFindDataCenterForCountry)

If parameter is not correct ISO 3166-1 two-letter country code,error is fired( err-code: InvalidInputParameters)

Availability of non US backup servers should be discussed during sales by dedicated request to Account Manager

AutoUpgradeClientApp

Indicates if all accounts of new company will use automatic update of client software

bool , Optional, false if missed

Code Block
DisableEmailsNotification

Allow to disable sending all emails notifications

bool , Optional, false if missed

...

Parameter

Description

Validation

TargetEntityID

ID of the Partner/Company/Distributor where new administrator is needed

Int, >=0. Use 0 for yourself.

UserName

Login name for dashboard. Names like 2222WS, 2222FL and U2222 are forbidden here.

Required, "^(?!^\d+(WS|Ws|wS|ws|FL|Fl|fL|fl)$)(?!^(U|u)\d+$)[a-zA-Z0-9@\._-]{3,50}$"

Password

Password, leave it empty if you want system to generate it

Optional, "^[a-zA-Z0-9!@#$%^&*()]{6,20}$"

Returns generated password and standard Result object. Can return following custom result codes. 

...

Parameter

Description

Validation

CompanyEntityId

Company ID

Required, Integer, > 0

GeneralContactPerson

Name of contact person

optional, string, "^[a-zA-Z]([a-zA-Z\.-]|\s){1,49}$"

If missed, current value is not changed.

GeneralContactEmail

Email

optional, string, "^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9_-]+)*\.([a-zA-Z]{2,}){1,49}$"

If missed, current value is not changed.

DiskQuotaGB

Storage quota for partner

Optional, Integer, > 0

If missed, current value is not changed.

AllowUploadOverAccountSize


optional, Bool

If missed, current value is not changed.

DataCenterCountryCodeIsoA2

ISO 3166-1 two-letter country code (alpha-2) 

Optional, string, can be empty.

Now available data centers in following countries:

US - UNITED STATES

GB -UNITED KINGDOM

AU -AUSTRALIA

CA -CANADA

ZA -SOUTH AFRICA

If missed, current value is not changed.

If empty, backup server for new backup accounts will be selected automatically .

If parameter is correct country code, all new backup accounts of this entity will persist data in scope of data centers restricted by region of specific country.Existing backup accounts will continue use back servers assigned when account was created.

If parameter is correct country code, but there are no data centers in that country, error is fired ( err-code: CannotFindDataCenterForCountry)

If parameter is not correct ISO 3166-1 two-letter country code,error is fired( err-code: InvalidInputParameters)

Availability of non US backup servers should be discussed during sales by dedicated request to Account Manager

AutoUpgradeClientApp

Indicates if all accounts of company will use automatic update of client software

bool , Optional, no changes if missed

...

Output Value

Description

Type

Units

CompanyEntityId

EntityId of company

Int


CompanyName

Name of company

String


DiskQuotaGB

Quota(Backup plan of Company)

Long

Gigabytes

UsedSpaceKB

Used space utilization by contained accounts

Long

Kilobytes

AllocatedSpaceMB

Space allocation by contained accounts

Long

Megabytes

NumberOfAccounts

Number of contained accounts

Int


NumberOfLicensesShadowProtectV5

Number of licenses assigned to company

Int


AllowUploadOverAccountSize

Shows if accounts are able to exceed company's quota

Boolean


DataCenterCountryCodeIsoA2

ISO 3166-1 two-letter country code (alpha-2). Shows

location of data center, where company backup accounts

are created.

String


User Account  Management

...

Output Value

Description

Type

AuthToken

Value can be used for autologin to Partner Dashboard according to pattern https://dashboard.managedoffsitebackup.net/Account/Login?uid={username}&token={tokenstring}, see example below

The access token has a “time-to-live” (ttl) - 30 minutes.

string

Example:

Request
Code Block
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">sosonlinebackup.com/GetAuthorizationTokenByEntity</Action>
    <h:AuthHeader xmlns="sosonlinebackup.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="sosonlinebackup.com">
      <UserName>AacmeES</UserName>
      <Password>V******</Password>
    </h:AuthHeader>
  </s:Header>
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetAuthorizationTokenByEntity xmlns="sosonlinebackup.com">
      <request>
        <Username>sdk.test@sosonlinebackup.com</Username>
        <IsAppUser>false</IsAppUser>
      </request>
    </GetAuthorizationTokenByEntity>
  </s:Body>
</s:Envelope>

...

Parameter

Description

Validation

EntityBackupPolicyID 

The unique ID of entity policy.  Used to identify entity policy.

Int.  Populated by SOS. On create entity policy just send 1.

TargetEntityID 

 ID of the parent Company/Partner. 

Int, >=0. Use 0 for yourself.

PolicyName

Unique name of policy

String, required, "^[\x20-\x3B\x3D\x3F-\x7F]*$";//ASCII without <>

DateCreated

Date when entity  policy was created.

DateTime.  Populated by SOS. On create entity policy just send any valid value.

BackupSet

Settings for the Smart Scanner

Object, Not mandatory

BackupSet.ScannerMode

Scope of scanning for file, i.e. where to scan.

Enum (ScanAll or ScanPersonal or DontScan)

BackupSet.BackupDocuments

Include document files to backup set.

Bool

BackupSet.BackupImages

Include image files to backup set.

Bool

BackupSet.BackupMusic

Include music files to backup set.

Bool

BackupSet.BackupVideo

Include video files to backup set. 

Bool

BackupSet.BackupCustom

Include files with specified in BackupSet.CustomFileTypes extensions

Bool

BackupSet.CustomFileTypes

Delimited list of custom file types to backup.

Used when  BackupSet.BackupCustom = true. 

String, Not mandatory.  E.g.: “xls, midi, txt”

Invalid characters are ASCII/Unicode characters 1 through 31, 

as well as quote ("), less than (<), greater than (>), pipe (|), backspace (\b), null (\0) and tab (\t).

Comma (,), dot (.), space ( ) and semicolon (;) are treated as separators. 

Empty extensions are ignored. 

BackupSet.ExcludeFileTypes

Delimited list of  file types to ignore.

It's applied to all types of the documents.

String, Not mandatory.  E.g.: “tmp, log, temp”

Invalid characters are ASCII/Unicode characters 1 through 31, 

as well as quote ("), less than (<), greater than (>), pipe (|), backspace (\b), null (\0) and tab (\t).

Comma (,), dot (.), space ( ) and semicolon (;) are treated as separators. 

 Empty extensions are ignored. 

Schedule

Settings for the scheduler.

Object, Not mandatory

Schedule.ScheduleType

How often backup should run

Enum (Monthly or Weekly or Daily or Hourly)

Schedule.ScheduledTime

When to run backup. Only time part is used.

DateTime.

Schedule.ScheduledEndTime* 

When to terminate running backup. Only time part is used. Cannot be combined with Hourly ScheduleType.

DateTime.

Schedule.UseEndTime* 

Activates ScheduledEndTime option.

Bool

Schedule.ScheduledDayOfTheMonth

Day of month to run. Used  when  ScheduleType = Montly.

1-31

Schedule.ScheduledDayOfTheWeek

Day of week to run. Used  when  ScheduleType = Weekly.

Sunday or Monday or Tuesday or Wednesday or Thursday or Friday or Saturday

Schedule.ScheduledHoursBetweenRuns

Interval between backup runs.  Used  when  ScheduleType = Hourly.

1-12

RunAs

Credentials to run PC Client with.

Required if you want to backup when user is not logged in. 

Object, Not mandatory

RunAs.RunAsDomainAndLogin

Windows domain name and login.

Optional, String, 

Code Block
@"^([^~!@#$\^&\*\(\)=\+\[\]\{\}\\\|;:'"",<>/\?\s]{1,15})\\(?!\x20+)([^~!@#$\^&\*\(\)=\+\[\]\{\}\\\|;:'"",<>/\?\s]{1,256})$"

  • Disallowed chars in user and domain/system name:  ~!@#$^&*()=+[]{}|;:'",<>/? and space

  • Domain/system name max length = 15 chars 

  • User name max length  in credentials  = 256.

  • Unicode is supported 

RunAs.RunAsPassword

Password for user above. it'll be kept  encrypted in SOS databases.

PC client don't keep it locally.

Optional, String

Options

Some options and triggers.

 Object, Not mandatory

Options.RunScheduledBackup

Turns on/off  scheduller.  

Bool, use “true”

Options.RunWhenNotLoggedOn

Activates RunAs section.  If it's false backup will run by scheduler

only if user is currently logged in.

Bool, use “false”

Options.SendEmailReportAfterBackup

Whether to send backup email report

Bool

Options.EmailAddressToSendReportsTo

Coma separated list of emails to send report to

String, Required if previous SendEmailReportAfterBackup is true.

Code Block
"^([a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9_-]+)*\.([a-zA-Z]{2,})($|[\s,;]+))+$"

Options.ExcludeFilesOlderThanDate

Exclude files that are older than inputed Date

DateTime, Optional

Options.ExcludeFilesLargerThanMb

Exclude files that are larger than inputed value in Mb

Integer, > 0, Optional

Options.ExcludeFilesSmallerThanKb

Exclude files that are smaller than inputed value in Kb

Integer, > 0, Optional

Options.RemoveFilesAfterDays

Time limited retention policy parameter. If file's modification date is less than Current Date - Options.RemoveFilesAfterDays, files will be removed from cloud

Integer, > 0, Optional, If value passed, EmailAddressToSendReportsTo must be true

Options.RemoveDeletedFilesAfterDays

Time limited retention policy parameter. If file have been deleted from Client PC, it will be also removed from cloud in RemoveDeletedFilesAfterDays days

Integer, > 0, Optional, If value passed, EmailAddressToSendReportsTo must be true

Code Block
UseSystemAccountForScanningUserPersonalFolders

When set to true OBRM 7.3+  uses SYSTEM account to run backup

Bool, use “false”

ScannerFileFilters**

Filter to apply to all files found by scanner.

Object, Not mandatory

ScannerFileFilters.Mode**

How filter will should work:

  • None -  Include*  & Exclude* filters are completely ignored. 

  • IncludeByWildcard  - Only Include* filter fields are taken into account. At least one Include* field  is required in this mode.

  • ExcludeByWildCard - Only Exclude* filter fields are taken into account. At least one Exclude* filed is required in this mode.

None 
or IncludeByWildcard,
or ExcludeByWildCard

ScannerFileFilters.IncludeFiles**

Semicolon separated values of file name (including extension) templates.

Optional, String, '"^(?!(.*[\x22\x3C\x3E\x7C\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F\x3A\x5C\x2F]+.*))[^;]+(;*[^;]+)+$"

  • Disallowed chars invalid for NTFS file name. E.g. /|>:

  • Allowed wildcards ? (any character in amount of 1 or 0)  and ? (any, including 0,  amount of any characters)

  • Cannot start or end with semicolon ( ; )

  • Unicode is supported 

ScannerFileFilters.IncludeFolders**

Semicolon separated values of folder path templates.

Optional, String, "^(?!(.*[\x22\x3C\x3E\x7C\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F]+.*))[^;]+(;*([^;]*[*?]+[^;]*)+)+$"

  • Disallowed chars invalid for NTFS folder path. E.g. <|>:

  • Allowed wildcards ? (any character in amount of 1 or 0)  and ? (any, including 0,  amount of any characters)

  • Cannot start or end with semicolon ( ; )

  • Each folder path template should include at least one wildcard character (* or ?)

  • UNC and local folder paths are supported

  • Unicode is supported 

ScannerFileFilters.ExcludeFiles**

Semicolon separated values of file name (including extension) templates.

Optional, String,'"^(?!(.*[\x22\x3C\x3E\x7C\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F\x3A\x5C\x2F]+.*))[^;]+(;*[^;]+)+$"

  • Disallowed chars invalid for NTFS file name. E.g. /|>:

  • Allowed wildcards ? (any character in amount of 1 or 0)  and ? (any, including 0,  amount of any characters)

  • Cannot start or end with semicolon ( ; )

  • Unicode is supported 

ScannerFileFilters.ExcludeFolders**

Semicolon separated values of folder path templates.

Optional, String,"^(?!(.*[\x22\x3C\x3E\x7C\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F]+.*))[^;]+(;*([^;]*[*?]+[^;]*)+)+$"

  • Disallowed chars invalid for NTFS folder path. E.g. <|>:

  • Allowed wildcards ? (any character in amount of 1 or 0)  and ? (any, including 0,  amount of any characters)

  • Cannot start or end with semicolon ( ; )

  • Each folder path template should include at least one wildcard character (* or ?)

  • UNC and local folder paths are supported

  • Unicode is supported 

LiveProtectWholeBackupSet**

When set to true OBRM 7.6+  automatically turns on LiveProtect  technology for each file found accordingly to Explicit Pathes ( aka GetBackupSetCustomPathes method data). LiveProtect technology ensures that file uploaded to the cloud shortly after it has been modified.

Bool, optional. Default and when not specified  is false

...

Parameter

Description

Validation

AccountBackupPolicyID

The unique ID of account policy.  Used to identify account policy.

Int.  Populated by SOS. On create account policy just send 1.

AccountName

Username


TargetEntityID 

 ID of the parent Company/Partner. 

 Int, >=0. Use 0 for yourself.

EntityBackupPolicyID


ID of Entity Policy to assign

Integer, >0

SystemName

Name of machine

String, Optional,

Code Block
@"^([^~!@#$\^&\*\(\)=\+\[\]\{\}\\\|;:'"",<>/\?\s]{1,25})$"

  • Disallowed chars:  ~!@#$^&*()=+[]{}|;:'",<>/? and space

  • max length = 25 

  • unicode is supported

If SystemName is not specified, policy applies to all devices where user with specified AccountName logs in.

PolicyName

Name of Entity Policy

Optional,  Ignored. On create account policy just leave empty.


DateCreated

Date when account policy was created.

DateTime.  Populated by SOS. On create account policy just send any valid value.

RunAs

Credentials to run PC Client with.

When defined they override Entity Policy Credentials.

Object, Not mandatory

RunAs.RunAsDomainAndLogin

Windows domain name and login.

Optional, String, 

Code Block
@"^([^~!@#$\^&\*\(\)=\+\[\]\{\}\\\|;:'"",<>/\?\s]{1,15})\\(?!\x20+)([^~!@#$\^&\*\(\)=\+\[\]\{\}\\\|;:'"",<>/\?\s]{1,256})$"

  • Disallowed chars in user and domain/system name:  ~!@#$^&*()=+[]{}|;:'",<>/? and space

  • Domain/system name max length = 15 chars 

  • User name max length  in credentials  = 256.

  • Unicode is supported 

RunAs.RunAsPassword

Password for user above. it'll be kept  encrypted in SOS databases.

PC client don't keep it locally.

Optional, String

...

Parameter

Description

Validation

AccountName

Username


EntityBackupPolicyID


ID of Entity Policy to assign

Integer, >0

SystemName

Name of machine

String, Optional

@"^([^~!@#$\^&\*\(\)=\+\[\]\{\}\\\|;:'"",<>/\?\s]{1,25})$"

  • Disallowed chars:  ~!@#$^&*()=+[]{}|;:'",<>/? and space

  • max length = 25

  • unicode is supported

If SystemName is not specified, policy applies to all devices where user with specified AccountName logs in. 

TargetEntityID 

ID of the parent Company/Partner. 

 Int, >=0. Use 0 for yourself.

...

Parameter

Description

Validation

AccountName

Username


SystemName

Name of machine

String, Optional. When it's not null  result set is filtered by provided system name.

@"^([^~!@#$\^&\*\(\)=\+\[\]\{\}\\\|;:'"",<>/\?\s]{1,25})$"

  • Disallowed chars:  ~!@#$^&*()=+[]{}|;:'",<>/? and space

  • max length = 25 

  • unicode is supported

TargetEntityID 

ID of the parent Company/Partner. 

 Int, >=0. Use 0 for yourself.

...

Parameter

Description

Validation

AccountName

Username


SystemName

Name of machine

String, Required

@"^([^~!@#$\^&\*\(\)=\+\[\]\{\}\\\|;:'"",<>/\?\s]{1,25})$"

  • Disallowed chars:  ~!@#$^&*()=+[]{}|;:'",<>/? and space

  • max length = 25

  • unicode is supported 

TargetEntityID

ID of the parent Company/Partner. 

 Int, >=0. Use 0 for yourself.

...

Output Value

Description

Type

Units

AccountName

Identifies account.

String


SystemName

Identifies system.

String


EntityId

Identifies entity (Company, Partner) for which account this event is fired.

Int


ClientDate

Identifies when event was fired on client side.

DateTime, UTC


HistoryRecoveryEventType

Possible values:

RecoveryCompleted

RecoveryFailed

String


RecoveryId

Identifies recovery

String


RecoveryDuration

Duration of recovery at moment when event was fired

Long

Seconds

ClientVersion

Version of backup software

String, formatted as: major.minor.build.revision


Summary

N/A

String




Appliances Management

...

Field

Description

Type

UserName

Backup account that uses device

string

SystemName

Device name

string

ProductVersion

Version of backup software

string, formatted as: major.minor.build.revision

RegistrationDateUtc

Describes when device successfully logged in first time

DateTime, UTC

OsName

Name of installed operating system

string

ClrVersion

Version of .NET (if installed )

string

...

Field

Description

Type

UserName

Backup account that uses device

string

SystemName

Windows system/computer/device name

string

Ip

Ip adress of device

string, e.g "8.8.4.4"

EntityID

Entity that owns  UserName

int

BackupDeviceID

Globally uinique device id

int

IsActiveUser

Is backup account active

boolean

IsActiveRegistration

Is it this device registration active

boolean

ProductVersion

Version of backup software

string, formatted as: major.minor.build.revision

UsedSpaceKb

Backed up data size, Kb

long

RegistrationDateUtc

Describes when device successfully logged in first time

DateTime, UTC

LastBackupDate

Last backup date

DateTime

LastConnectedDateUtc

Version of .NET (if installed )

DateTime, UTC

...

Production: https://secure.sosonlinebackup.com/WebAPI/AccountManagementService/CloudApplicationBackupManagementService.asmx?op=EnableBackup

Request:


Parameter

Description

Validation

ForEntityId

Entity owner of ICAB account

int

Email

Login of ICAB account

string, can be null. When null GeneralContactEmail of entity is used.

Region

Location of data center

string, can be null. When null  'US_EST' is used.

Valid values are (without quotes):  'US_EST' , 'CANADA', 'EU'  and  'ASIA_SIDNEY'

...

An opposite to EnableBackup method. Disables Infrascale Cloud Applications Backup for given entity by un-subscribing its account from ICAB Services.

Request:


Parameter

Description

Validation

TargetEntityID

EntityID of the Partner/Company/Distributor which ICAB account you want to disable, i.e unsubscribe from ICAB Services.

Int, >=0. Use 0 for yourself.

...

Parameter

Description

Validation

TargetEntityID

EntityID of the Partner/Company/Distributor for which you want to get cloud backup usage

int, >=0. Use 0 for yourself.

PageNumber

The page number

int >= 1

PageSize

The number of companies to display per page

int > 0, Default value: 1000

Request example:

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sos="sosonlinebackup.com"> 
    <soapenv:Header> 
        <sos:AuthHeader>
            <sos:UserName>21***</sos:UserName>
            <sos:Password>k*****</sos:Password>
        </sos:AuthHeader>
    </soapenv:Header> 
    <soapenv:Body>
        <sos:GetCloudUsage>
            <sos:request> 
                <sos:ForEntityID>523</sos:ForEntityID> 
                <sos:PageNumber>1</sos:PageNumber>
                <sos:PageSize>1000</sos:PageSize>
            </sos:request> 
        </sos:GetCloudUsage> 
    </soapenv:Body> 
</soapenv:Envelope>

Response:

Returns result as array where each item describes cloud backup usage for an used cloud service:

Field

Description

Type

LastBackupDate

Last backup date

DateTime, can be null

Accounts

For the user based pricing the number of activated accounts

long, can be null

StorageBytes

For the storage based pricing the number of used storage (in bytes)

long, can be null

Source

Service internal type

string

Service

Service name

string

ICABAccountName

Name of the ICAB account

string

AccountDateCreated

Date of creating of ICAB account

DateTime

CompanyID

EntityID of the Partner/Company/Distributor which uses cloud backup

int

CompanyName

name  of Partner/Company/Distributor which uses cloud backup

string

ConfiguredDate

date when was configured the backup for the service

DateTime, can be null

PageNumber

number of a current page

int

NumberOfPages

Total number of pages

int

TotalCount

Total number of companies for the request

int

...