Service - Backup Management

The functionality that make up this service and the functions that can be called.
 
Lists all backup storage.
 
Function: GetBackupStorage (parameter1, parameter2)
 
Input Parameter
Type
Description
UserApiKey
String 
User with permissions to call this web service.
UserApiPassword 
String
User’s password of the user used in UserApiKey parameter.
 
Returns: BackupStorageListWithDetailsInfoResult
 
Field
Type
Description
Message
String
A text message explaining the results of the operation, including the reason for any failures.
Result
Boolean
Returns true if the function call was successful.
Result_Code
Int32
A result code, which differs by function.
BackupStorageDetailsList 
BackupStorage_Details[] 
A list of the user’s backup storage with details, as defined in the BackupStorage_Details class.
 
 
Get backup storage full details for a backup storage assigned to a user.
 
Function: GetBackupStorageDetail(parameter1, parameter2, parameter3)
 
Input Parameter
Type
Description
UserApiKey
String
User with permissions to call this web service.
UserApiPassword 
String
User’s password of the user used in UserApiKey parameter.
BackupSpaceId
Integer 
The backup space id.
 
Returns: BackupStorageFullDetailsInfoResult
 
Field
Type
Description
Message
String
A text message explaining the results of the operation, including the reason for any failures.
Result
Boolean
Returns true if the function call was successful.
Result_Code
Int32
A result code, which differs by function.
BackupStoragFullDetails 
BackupStorage_Full_Details 
Details of the backup storage, as defined in the BackupStorage_Full_Details class.
 
 
Updates the FTP details for a backup storage.
 
Function: UpdateFTP(parameter1, parameter2, parameter3, parameter4)
 
Input Parameter
Type
Description
UserApiKey
String
User with permissions to call this web service.
UserApiPassword
String
User’s password of the user used in UserApiKey parameter.
BackupSpaceId
Integer
The backup space id.
BackupStorageUpdateDetails 
BackupStorage_Update_Details 
The backup storage details to set(update), as defined in the BackupStorage_Update_
Details class.
 
Returns: BackupStorageInfoResult
 
Field
Type
Description
Message
String
A text message explaining the results of the operation, including the reason for any failures.
Result
Boolean 
Returns true if the function call was successful.
Result_Code 
Int32
A result code, which differs by function.
 
 
Object - BackupStorage_Details
 
Field
Type
Description
Backup_Space_Id
String 
The backup space id.
Backup_Space_Name 
String
The backup space name.
Server_label
String
The server label.
User_Name
String
The user name.
 
 
Object - BackupStorage_Full_Details
 
Field
Type
Description
Backup_Space_Id
String 
The backup space id.
Backup_Space_Name
String
The backup space name.
Server_label
String
The server label.
User_Name
String
The user name.
Private_FTP_User_Name 
String
The private user name.
Private_FTP_IP_Address
String
The private IP address.
Private_FTP_Enabled
String
The private enabled switch.
Public_FTP_User_Name
String
The public user name.
Public_FTP_IP_Address
String
The public IP address.
Public_FTP_Enabled
String
The public enabled switch.
Total_Size
String
The total size.
Remaining_Space
String
The remaining space.
 
 
Object - BackupStorage_Update_Details
 
Field
Type
Description
Private_FTP_Password 
String 
The private FTP password.
Private_FTP_Enabled
String
The private FTP enabled switch. A literal:  “True” or “False”.
Public_FTP_Password
String
The public FTP password.
Public_FTP_Enabled
String
The public FTP enabled switch. A literal:  “True” or “False”.

Add Feedback