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 (only with CentOS 7)
  • plesk_web_admin_license (No. of Domains - 10)
  • plesk_web_pro_license (No. of Domains - 30)
  • plesk_web_host_license (No. of Domains - Unlimited)
  • whmcs
  • storage_1
  • storage_2
  • storage_3
  • storage_4
  • storage_5
Note

Storage as an addon is available only for SSD servers in the US location
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.
discount-amount Float Optional Discount amount for the order value.

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&discount-amount=0.00 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&discount-amount=0.00

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)

  • Discount Amount (discount-amount)

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.

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

Note

W.E.F. 26 August 2020, you will not be able to purchase a new Dedicated Server by Hostgator (Product Key : hostgatordedicatedserverlinuxus) or Dedicated Server by Bluehost (Product Key : bluehostdedicatedserverlinuxus). However you can continue to renew your existing orders.