Knowledge Base
Categories: VPS Linux API
Add Block Storage to a VPS Linux KVM Server Using the API
When you want to add block storage to a VPS server using the API. This article explains storage parameters, attachment requirements, billing options, and API request details for block storage provisioning.
Description
Places a Block Storage Order for the specified VPS server order
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Your Live Account Reseller Id |
| api-key | String | Required | An alphanumeric code that can be used to authenticate your API calls |
| 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. |
| auto-renew | Boolean | Required |
Enables / Disables the Auto Renewal setting for the Order |
| 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.
Did you find this article helpful?