![]() |
dedicatedserverlinuxus
Reseller should be signed up for Dedicated Server Linux product
Get Reseller Pricing
Description
Use this method to get details of the pricing for the Dedicated Server Linux plans for your Sub-Resellers.
Response
Returns a map with the prices of the Dedicated Server Linux plans along with the prices of the other products.
The response structure for the Dedicated Server Linux product will be:
"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}
Example:
US Server
"dedicatedserverlinuxus":
{
"addons":
{
"storage_1":0.0,
"cpanel":0.0,
"whmcs":0.0,
"ipaddress":0.0,
"storage_5":0.0,
"storage_4":0.0,
"storage_3":0.0,
"storage_2":0.0
},
"plans":
{
"105":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"106":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}
Get Customer Pricing
Description
Use this method to get details of the pricing for the Dedicated Server Linux plans for your Customers.
Response
Returns a map with the prices of the Dedicated Server Linux plans along with the prices of the other products.
The response structure for the Dedicated Server Linux product will be:
US Server
"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}
Example:
"dedicatedserverlinuxus":
{
"addons":
{
"storage_1":0.0,
"cpanel":0.0,
"whmcs":0.0,
"ipaddress":0.0,
"storage_5":0.0,
"storage_4":0.0,
"storage_3":0.0,
"storage_2":0.0
},
"plans":
{
"105":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"106":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}
Search Orders
Description
Gets a list and details of the Dedicated Server Linux Orders matching the search criteria.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| no-of-records | Integer | Required | Number of Orders to be fetched |
| page-no | Integer | Required | Page number for which details are to be fetched |
| order-id | Array of Integers | Optional | Order ID(s) of the Dedicated Server Linux Order(s) whose details need to be fetched |
| reseller-id | Array of Integers | Optional | Reseller ID(s) whose Dedicated Server Linux Orders need to be fetched |
| customer-id | Array of Integers | Optional | Customer ID(s) whose Dedicated Server Linux Orders need to be fetched |
| show-child-orders | Boolean | Optional | Whether Sub-Reseller Orders need to be fetched or not |
| status | Array of Strings | Optional | Status of the Order: Active, InActive, Suspended or Deleted |
| domain-name | String | Optional | Name of the Domain of the Dedicated Server Linux Order |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of the Dedicated Server Linux Orders whose Creation Date is greater than creation-date-start |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of the Dedicated Server Linux Orders whose Creation Date is less than creation-date-end |
| expiry-date-start | String | Optional | UNIX TimeStamp for listing of the Dedicated Server Linux Orders whose expiry date is greater than expiry-date-start |
| expiry-date-end | String | Optional | UNIX TimeStamp for listing of the Dedicated Server Linux Orders whose expiry date is less than expiry-date-end |
| order-by | Array of Strings | Optional | One or more parameters by which you want to sort the Orders. Default is orderid.
Example: If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. |
HTTP Method
GET
Example Test URL Request
US Server
https://test.httpapi.com/api/dedicatedserver/linux/us/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1
Response
Returns a hash map containing the below details of the Dedicated Server Linux Orders which match the search criteria:
-
Domain Name (entity.description)
-
Order Id (orders.orderid)
-
Customer Id (entity.customerid)
-
Order Creation Timestamp (orders.creationtime)
-
Order Expiry Timestamp (orders.endtime)
-
Current Order Status (entity.currentstatus) - value will be InActive, Active, Suspended or Deleted
-
Product Name (entitytype.entitytypename)
-
Product Key (entitytype.entitytypekey)
-
Type of Operating System (hosting_group_info.os_type)
-
Data Center location for the Managed Server (hosting_group_info.location)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Get Order Id
Description
Gets the associated Dedicated Server Linux Order ID from the domain name.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | String | Required | The domain name for which the Order ID is to be fetched |
HTTP Method
GET
Example Test URL Request
US Server
https://test.httpapi.com/api/dedicatedserver/linux/us/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia
Response
Returns the associated Dedicated Server Linux Order ID (Integer) of the domain name.
Get Plan Details
Description
Use this method to get details of your plans.
Response
Returns details of the plans of the Dedicated Server Linux product, along with the plan details of other Products of the Reseller.
Example:
The response structure for the Dedicated Server Linux product will be:
US Server
"dedicatedserverlinuxus":
{
"plan-id":
{
"supported_os":
[
{
"os_display_name":"OS Display Name",
"os_name":"OS Name",
"addons":
[
{
"addon_name":"storage_1",
"type":"SATA",
"is_paid":(true or false),
"space":51200,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"storage_2",
"type":"SATA",
"is_paid":(true or false),
"space":102400,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"storage_3",
"type":"SATA",
"is_paid":(true or false),
"space":204800,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"storage_4",
"type":"SATA",
"is_paid":(true or false),
"space":307200,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"storage_5",
"type":"SATA",
"is_paid":(true or false),
"space":512000,
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"ipaddress",
"is_paid":(true or false),
"free_quantity":2,
"conflicting_addon_names":[]
},
{
"addon_name":"cpanel",
"is_paid":(true or false),
"free_quantity":0,
"conflicting_addon_names":[]
},
{
"addon_name":"whmcs",
"is_paid":(true or false),
"free_quantity":0,
"conflicting_addon_names":[]
}
],
"is_default"(true or false)
}
],
"plan_name":"Plan Name",
"bandwidth":value,
"ram":
{
"ram_memory":value,
"ram_type":"RAM Type"
},
"storage":
{
"storage_raid_level":value,
"storage_space":value,
"storage_type":"SATA"
},
"cpu":
{
"cpu_speed":"value",
"cpu_hyper_threaded":(true or false),
"cpu_processor_type":"Processor Type",
"cpu_cores":value
}
}
}
Get Details
Description
Gets the details of an existing Dedicated Server Linux Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The Order ID for which the details to be fetched |
HTTP Method
GET
Example Test URL Request
US Server
https://test.httpapi.com/api/dedicatedserver/linux/us/details.json?auth-userid=0&api-key=key&order-id=0
Response
Returns a hash map containing the below details:
-
Order ID (entityid)
-
Order Description (description)
-
Domain Name (domainname)
-
Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted
-
Product key (productkey)
-
Product Category (productcategory)
-
Order Creation Date (creationtime)
-
Expiry Date (endtime)
-
Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)
-
Reseller Chain by RID (parentkey)
-
Customer ID Associated with the Order (customerid)
-
Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)
-
Whether Order Suspended by Parent Reseller (orderSuspendedByParent)
-
Whether Order Deletion is Allowed (allowdeletion)
-
Cost Price for Reseller (resellercost)
-
Cost Price for Customer (customercost)
-
IP Address (ipaddress)
-
Plan ID of the Dedicated Server Plan (planid)
-
Status of the Dedicated Server Plan (paused)
-
Admin User for the Dedicated Server Order (siteadminusername)
-
Password for the above Admin USer (siteadminpassword)
-
Installed Operating System (os_name)
-
Details of the Addons (addons)
-
Addon ID of the Addon (addon_id)
-
Addon Name (addon_name)
-
Addon Creation Date (creation_time)
-
Payment Status for the Addon (is_paid)
-
IP Address (ipaddress)
-
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Delete
Description
Deletes an existing Dedicated Server Linux Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The Order ID which is to be deleted |
HTTP Method
POST
Example Test URL Request
US Server
https://test.httpapi.com/api/dedicatedserver/linux/us/delete.json?auth-userid=0&api-key=key&order-id=0
Response
Returns a hash map containing the below details:
-
Domain Name (description)
-
Order ID of the Dedicated Server Order (entityid)
-
Action Type (actiontype)
-
Description of the Dedicated Server Order Delete Action (actiontypedesc)
-
Action ID of the Dedicated Server Order Delete Action (eaqid)
-
Dedicated Server Order Delete Action Status (actionstatus)
-
Description of the Dedicated Server Order Delete Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Unsuspend
Please wait while you are redirected ....
Suspend
Please wait while you are redirected ....
