Knowledge Base
Upgrade Block Storage Using the API
When your system or integration needs to increase the capacity of an existing Block Storage order. This article explains the API request parameters required to upgrade block storage, including specifying the target storage size, invoice handling options, and response details.
Description
Upgrade an existing 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 | The order-id of the storage which is to be upgraded. |
| storage-size-gb | Integer | Required |
Enter the final value of the storage that you want it to be upgraded to. Max available limit is 500 GB. Example: If you have a storage block of 10 GB and wish to upgrade to 35 GB enter 35 as the value in this parameter and not the incremental value, i.e. 25 |
| 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/blockstorage/us/upgrade.json?auth-userid=0&api-key=key&storage-size-gb=0&order-id=0&invoice-option=NoInvoice
Response
Returns a map of the execution details of the upgrade operation.
Did you find this article helpful?