vpslinux

Reseller should be signed up for the VPS Linux US or VPS Linux IN Product.

Search Orders

Description

Gets a list and details of the VPS 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 VPS Linux Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller Id(s) of the Reseller(s) whose Orders need to be fetched
customer-id Array of Integers Optional Customer Id(s) of the Customer(s) whose 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, Deleted, etc.
domain-name String Optional Domain name associated with the VPS Linux Order
creation-date-start String Optional UNIX TimeStamp for listing of the VPS Linux Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the VPS Linux Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the VPS Linux Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the VPS 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.
If page-no is 2, no-of-records is 30 and order-by is orderid; it will fetch the second batch of 30 Orders sorted by orderid.

HTTP Method

GET

Example Test URL Request

US Server


https://test.httpapi.com/api/vps/linux/us/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

India Server


https://test.httpapi.com/api/vps/linux/in/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1


Response

Returns the list of the VPS Linux Orders which match the search criteria.

Get Order Id

Description

Gets the associated VPS 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/vps/linux/us/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

India Server


https://test.httpapi.com/api/vps/linux/in/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia


Response

Returns the associated VPS 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 VPS Linux product, along with the plan details of other Products of the Reseller.

Example:

US Server

The response structure for the VPS Linux US product will be:


"vpslinuxus":
{
"plan-id":
{
"supported_os":
[
{
"os_display_name":"OS Display Name",
"os_name":"OS Name",
"addons":
[
{
"addon1-name":"Addon1 Name",
"is_paid":(true or false),
"no_of_domains":value,
"free_quantity":value,
"conflicting_addon_names":["addon2-name"]
},
{
"addon2-name":"Addon2 Name",
"is_paid":(true or false),
"no_of_domains":value,
"free_quantity":value,
"conflicting_addon_names":["addon1-name"]
},
{
"addon3-name":"Addon3 Name",
"is_paid":(true or false),
"no_of_domains":value,
"free_quantity":value,
"conflicting_addon_names":[]
}
],
"is_default"(true or false)
}
],
"plan_name":"Plan Name",
"bandwidth":value,
"ram":value,
"space":value,
"cpu":value
}
}

India Server

The response structure for the VPS Linux India product will be:


"vpslinuxin":
{
"plan-id":
{
"supported_os":
[
{
"os_display_name":"OS Display Name",
"os_name":"OS Name",
"addons":
[
{
"addon1-name":"Addon1 Name",
"is_paid":(true or false),
"no_of_domains":value,
"free_quantity":value,
"conflicting_addon_names":["addon2-name"]
},
{
"addon2-name":"Addon2 Name",
"is_paid":(true or false),
"no_of_domains":value,
"free_quantity":value,
"conflicting_addon_names":["addon1-name"]
},
{
"addon3-name":"Addon3 Name",
"is_paid":(true or false),
"no_of_domains":value,
"free_quantity":value,
"conflicting_addon_names":[]
}
],
"is_default"(true or false)
}
],
"plan_name":"Plan Name",
"bandwidth":value,
"ram":value,
"space":value,
"cpu":value
}
}

Get Details

Description

Gets the details of an existing VPS 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 Order ID of the Order for which the details are to be fetched

HTTP Method

GET

Example Test URL Request

US Server


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

India Server


https://test.httpapi.com/api/vps/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 VPS Plan (planid)

  • Status of the VPS Plan (paused)

  • Admin User for the VPS Order (siteadminusername)

  • Password for the above Admin USer (siteadminpassword)

  • Whether the VPS Plan includes WHMCS Addon (includes_whmcs)

  • Installed Operating System (os_name)

  • Details of the Addons (addons)

    • Addon ID of the Addon (addOnID)

    • Addon Name (name)

    • Addon Creation Date (creationTime)

    • Payment Status for the Addon (is_paid)

    • License Key for the WHMCS Addon (licenseKey)

    • Number of Domains for the Plesk Addon (noOfDomains)

    • Login URL for the cPanel / Plesk / Virtuozzo Addon (loginURL)

    • Admin User for the cPanel / Plesk / Virtuozzo Addon (username)

    • 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 VPS 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 Order ID of the Order which is to be deleted

HTTP Method

POST

Example Test URL Request

US Server


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

India Server


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


Response

Returns a map of the execution details of the delete operation.

Delete Add-on

Description

Deletes the specified Add-on of the VPS 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 Order ID of the Order 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/vps/linux/us/delete-addon.json?auth-userid=0&api-key=key&order-id=0&addon-id=0

India Server


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


Response

Returns a map of the execution details of the deleting Add-on operation.

Add Add-on

Description

Adds the specified Add-on for an existing VPS 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 Order ID of the Order for which the specified Add-on(s) is/are to be added
addon String Required Add-ons can be one of the following:
  • ssl
  • cpanel
  • plesk_10_domain
  • plesk_100_domain
  • plesk_unlimited_domain
  • whmcs
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
Note
  • VPS 1 and VPS 2 Plans will support only ssl, plesk_10_domain and whmcs Add-ons.

  • VPS 3 Plan onwards will support all Add-ons.

  • Only 1 Plesk license (among plesk_10_domain, plesk_100_domain and plesk_unlimited_domain) can be installed on an Order.

  • cPanel & Plesk licenses can not be installed on an Order simultaneously, since these are conflicting Add-ons.

HTTP Method

POST

Example Test URL Request

US Server


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

India Server


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


Response

Returns a map of the execution details of the adding Add-on operation.

Modify/Upgrade

Description

Modifies/upgrades an existing VPS Linux Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Order which is to be modified
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details i.e., plan-id etc, use this method.
months Integer Required The number of months in the new plan for which the Order is to be modified
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request

US Server


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

India Server


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


Response

Returns a map of the execution details of the modify operation.