Get Details

Description

Gets the details of an existing VPS Block Storage 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/blockstorage/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)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Volume Details (attachedOrders) 

    • Current Volume Status (currentstatus)

    • Volume Mount Point (mountPoint)

    • Volume ID (orderid) 

    • Volume Status (storageStatus)

  • Storage Status (storageStatus)

  • Product key (productkey)

  • Product Category (productcategory)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

  • Storage Size (storageSizeGb)

  • Reseller Chain by RID (parentkey)

  • Order Creation Date (creationtime)

  • Whether Auto-Renewal is enabled (recurring)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Customer ID Associated with the Order (customerid)

  • Plan ID of the Block Storage Plan (planid)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Volume Name (domainname)

  • Whether Order Deletion is Allowed (allowdeletion)

  • Money Back Period (moneybackperiod)

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