The functionality that make up this service and the functions that can be called.
List all IP blocks (and details) for the user’s servers as well as the IP blocks that belong to sub-users servers.
Function: GetAllBlocks (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: IPBlocksListWithDetailsInfoResult
|
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. |
| IPBlockDetailsList |
IPBlock_Details[] |
A list all IP blocks with details for the user’s servers, as defined in the IPBlock_Details class. |
List all IP blocks (and details) for a server belonging to the user.
Function: GetServerIPBlocks (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: IPBlocksListWithDetailsInfoResult
|
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. |
| IPBlockDetailsList |
IPBlock_Details[] |
A list all IP blocks with details for the user’s servers, as defined in the IPBlock_Details class. |
Get the IP block details for an IP address Id.
Function: GetIPBlockDetails (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. |
| IPAddressId |
Integer |
The IP Address id. |
Returns: IPBlocksDetailsInfoResult
|
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. |
| IPBlockDetails |
IPBlock_Details |
IP blocks with details for the user’s servers, as defined in the IPBlock_Details class. |
Object - IPBlock_Details
|
Field
|
Type
|
Description
|
| IPAddress_Id |
Integer |
The IP address Id. |
| Server_Id |
Integer |
The server Id. |
| IP_Description |
String |
The IP description (a.k.a. the IP block). |
| IP_Gateway |
String |
The IP gateway. |
| IP_Subnet |
String |
The IP subnet. |
| IP_Usable_Range |
String |
The IP usable range |
| Primary_IP_Block |
Boolean |
Indicates the primary IP block |
| User_Id |
Integer |
The user id. |
Article ID: 225, Created: July 16, 2015 at 2:07 PM, Modified: September 2, 2015 at 2:53 PM