reseller

is added when reseller has a customer specific business

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.

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

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


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.


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


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


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.


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

New gTLD Wishlist Setup

Following are the steps you need to perform from within your Control Panel for the New gTLD Wishlist Setup: