Knowledge Base

Add a Dedicated Linux Server Order Using the API

When you want to place a Dedicated Linux Server order using the API. This article explains server configuration options, operating system selection, add-ons, billing settings, and API request details.

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_7 centos_8 ubuntu_16 ubuntu_18 ubuntu_20 debian_9 debian_10
addon	Array of Strings	Optional	Additional Add-ons to be purchased. Values can be: 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 HDD servers in US location.
auto-renew	Boolean	Required	Enables / Disables the Auto Renewal setting for the Order Note Auto-Renewal
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/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice&discount-amount=0.00&os=debian_8

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)
Discount Amount (discount-amount)

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.