The functionality that make up this service and the functions that can be called.
List of all servers for the user as well as the servers that belong the user’s sub-users.
Function: GetListAllServers (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: UsersServerListWithDetailsInfoResult
|
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. |
| UserServerDetailsList |
User_Server_Details[] |
A list of the user’s servers with details, as defined in the User_Server_Details class. |
List of all servers for the reseller’s sub-users.
Function: GetListUsersServers (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. |
| UserName |
String |
The user name of the reseller’s sub-user. |
Returns: SubUsersServerListWithDetailsInfoResult
|
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. |
| SubUsersServerDetailsList |
SubUser_Servers_Details[] |
A list of the sub-user’s servers with details, as defined in the SubUsers_Server_Details class. |
Get server details for a server assigned to a user.
Function: GetServerDetails (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. |
| ServerId |
Integer |
The server id. |
Returns: ServerDetailsInfoResult
|
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. |
| ServerDetails |
Servers_Details |
Details of the server, as defined in the Server_Details class. |
| IPBlocksList |
IP_Block[] |
A list of the IP blocks assigned to the server, as defined in the IP_Block class. |
Assigns the server to a reseller's sub-user OR unassigns the server from the reseller's sub-user and reassigns it back to the reseller.
Function: UpdateServerUser (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.
|
|
ServerId
|
Integer
|
The server id.
|
|
UserName
|
String
|
The user name to be assigned to the server. If set to blank, it will do the unassign processing.
|
Returns: ServerInfoResult
|
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. |
Send an IPMI command to power on, power off or reset the server.
Function: SendIPMICommand (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. |
| ServerId |
Integer |
The server id. |
| Action |
String |
The action - the command: “Power On”, “Power Off” or “Reset”. |
Returns: ServerInfoResult
|
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 - User_Server_Details
|
Field
|
Type
|
Description
|
| Server_Id |
Integer |
The server Id. |
| Server_Label |
String |
The server label. |
| Status |
String |
The status. |
| User_Name |
String |
The User Name of the User assigned to the server. |
Object - SubUsers_Server_Details
|
Field
|
Type
|
Description
|
| Server_Id |
Integer |
The server Id. |
| Server_Label |
String |
The server label. |
| Status |
String |
The status. |
Object - Server_Details
|
Field
|
Type
|
Description
|
| Server_Id |
Integer |
The server Id. |
| Server_Name |
String |
The server name. |
| Data_Center |
String |
The data center. |
| Status |
String |
The status. |
| Processor |
String |
The processor. |
| Memory |
String |
The memory. |
| Hard_Drive1 |
String |
The hard drive 1 capacity. |
| Hard_Drive2 |
String |
The hard drive 2 capacity. |
| Hard_Drive3 |
String |
The hard drive 3 capacity. |
| Hard_Drive4 |
String |
The hard drive 4 capacity. |
| Raid_Name |
String |
The raid name. |
| Primary_NIC |
Integer |
The primary NIC. |
| Port_Speed |
String |
The port speed. |
| Additional_Details |
String |
Additional details. |
| Operating_System |
String |
The operating system. |
| User_Name |
String |
The logged in user name. |
| User_Password |
String |
The logged in user password. |
| Bandwidth_Used |
Double |
The bandwidth used. |
| Bandwidth_Allowed |
Double |
The bandwidth allowed. |
| KVM_IP |
String |
The KVM IP address. |
| KVM_User_Name |
String |
The KVM user name. |
| KVM_Password |
String |
The KVM password. |
| Servers_User_Name |
String |
The user name assigned to the server. |
Object - IP_Block
|
Field
|
Type
|
Description
|
| IP_Block |
String |
The IP Block assigned to the server. |
Article ID: 224, Created: July 16, 2015 at 2:07 PM, Modified: September 2, 2015 at 8:15 PM