Add Block Storage

Description

Places a Block Storage Order for the specified VPS server order

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer ID of the Customer under whom the Order should be added
months Integer Required The number of months for which the Order is 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.
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 Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
storage-size-gb Integer Required Specify the size of the additional volume.
10 GB to 500 GB
attach-order-id Integer Required  The orderid of the server to which the volume must be attached after purchase. The server must be from the same data center. 

HTTP Method

POST

Example Test URL Request

US Server https://test.httpapi.com/api/blockstorage/us/add.json?auth-userid=0&api-key=key&customer-id=0&months=1&plan-id=0&invoice-option=NoInvoice&storage-size-gb=10&attach-order-id=0 

Response

Returns a hash map containing the below details:

  • Volume Name (description)

  • Order ID of the Order (entityid)

  • Action Type (actiontype)

  • Description of the Block Storage Order Add Action (actiontypedesc)

  • Action ID of the Block Storage Order Add Action (eaqid)

  • Order Add Action Status (actionstatus)

  • Description of the Block Storage Order Add Action Status (actionstatusdesc)

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.