reseller

is added when reseller has a customer specific business

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
}
}
}


Hong Kong Server

"dedicatedserverlinuxhk":
{
"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


Hong Kong Server

https://test.httpapi.com/api/dedicatedserver/linux/hk/details.json?auth-userid=0&api-key=key&order-id=0



India Server

https://test.httpapi.com/api/dedicatedserver/linux/in/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


Hong Kong Server

https://test.httpapi.com/api/dedicatedserver/linux/hk/delete.json?auth-userid=0&api-key=key&order-id=0


India Server

https://test.httpapi.com/api/dedicatedserver/linux/in/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.

Delete Add-on

Description

Deletes the specified Add-on of the 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 specified Add-on is to be deleted
addon-id Integer Required ID of the Add-on to be deleted. Use this method to fetch the Add-on ID.

HTTP Method

POST

Example Test URL Request


US Server

https://test.httpapi.com/api/dedicatedserver/linux/us/addon/delete.json?auth-userid=0&api-key=key&order-id=0&addon-id=0


Hong Kong Server

https://test.httpapi.com/api/dedicatedserver/linux/hk/addon/delete.json?auth-userid=0&api-key=key&order-id=0&addon-id=0


India Server

https://test.httpapi.com/api/dedicatedserver/linux/in/addon/delete.json?auth-userid=0&api-key=key&order-id=0&addon-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 Delete Add-on Action (actiontypedesc)

  • Action ID of the Delete Add-on Action (eaqid)

  • Delete Add-on Action Status (actionstatus)

  • Description of the Delete Add-on Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Add Add-on

Description

Adds the specified Add-on for 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 specified Add-on(s) is/are to be added
addon String Required Add-ons can be one of the following:
  • ipaddress
  • cpanel
  • whmcs
  • storage_1
  • storage_2
  • storage_3
  • storage_4
  • storage_5
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


US Server

https://test.httpapi.com/api/dedicatedserver/linux/us/addon/add.json?auth-userid=0&api-key=key&order-id=0&addon=ssl&invoice-option=NoInvoice


Hong Kong Server

https://test.httpapi.com/api/dedicatedserver/linux/hk/addon/add.json?auth-userid=0&api-key=key&order-id=0&addon=ssl&invoice-option=NoInvoice



India Server

https://test.httpapi.com/api/dedicatedserver/linux/in/addon/add.json?auth-userid=0&api-key=key&order-id=0&addon=ssl&invoice-option=NoInvoice

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 Add Add-on Action (actiontypedesc)

  • Action ID of the Add Add-on Action (eaqid)

  • Add Add-on Action Status (actionstatus)

  • Description of the Add Add-on Action Status (actionstatusdesc)

  • Invoice ID of the Add Add-on Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Dedicated Server Order (customerid)

Note
  • invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

  • The storage addons are not available for Servers located in India and Hong Kong.


  • The WHMCS addon is not available for Servers located in Hong Kong.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Renew

Description

Renews 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 renewed
months Integer Required The number of months for which the Order is to be renewed
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


US Server

https://test.httpapi.com/api/dedicatedserver/linux/us/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice


Hong Kong Server

https://test.httpapi.com/api/dedicatedserver/linux/hk/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice



India Server

https://test.httpapi.com/api/dedicatedserver/linux/in/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

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 Renew Action (actiontypedesc)

  • Action ID of the Dedicated Server Order Renew Action (eaqid)

  • Dedicated Server Order Renew Action Status (actionstatus)

  • Description of the Dedicated Server Order Renew Action Status (actionstatusdesc)

  • Invoice ID of the Dedicated Server Order Renew Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Dedicated Server Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Add

Description

Places a Dedicated Server Linux Order for the specified 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 to be placed
customer-id Integer Required The Customer under whom the Order should be added
months Integer Required The number of months for which the Order to be placed
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method.
os String Optional The operating system to be installed on the server. Values can be:
  • centos_6
  • centos_7
  • ubuntu_14
  • ubuntu_16
addon Array of Strings Optional Additional Add-ons to be purchased. Values can be:
  • ipaddress
  • cpanel
  • whmcs
  • storage_1
  • storage_2
  • storage_3
  • storage_4
  • storage_5
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


US Server

https://test.httpapi.com/api/dedicatedserver/linux/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice


Hong Kong Server

https://test.httpapi.com/api/dedicatedserver/linux/hk/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice



India Server

https://test.httpapi.com/api/dedicatedserver/linux/in/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

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 Add Action (actiontypedesc)

  • Action ID of the Dedicated Server Order Add Action (eaqid)

  • Dedicated Server Order Add Action Status (actionstatus)

  • Description of the Dedicated Server Order Add Action Status (actionstatusdesc)

  • Invoice ID of the Dedicated Server Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Dedicated Server Order (customerid)

Note
  • invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

  • The OS flavors centos_7, ubuntu_14 & ubuntu_16 are available for only Servers located in India and Hong Kong.

  • The storage addons are not available for Servers located in India and Hong Kong.


  • The WHMCS addon is not available for Servers located in Hong Kong.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.