Loading...

Knowledge Base
Home 
 
/
 Get the Details of a Dedicated Linux Server Order Using the API
Categories: Dedicated Server Linux API

Get the Details of a Dedicated Linux Server Order Using the API

When you want to retrieve the details of an existing Dedicated Linux Server order using the API. This article explains the required authentication parameters, order ID input, server details, addon information, operating system details, admin account information, order status information, and order response details.

Get Details

Description

Gets the details of an existing Dedicated Server Linux Order.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
order-idIntegerRequiredThe 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

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)

  • Whether Auto-Renewal is enabled (recurring)

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