Sign in

v1

latestOpenAPI 3.0.02026-07-13288558.3 KB

/volumes/{id}/info

Get details for the specified storage volume.

get/volumes/{id}/info

Response

Return a volume object.

idstring required

The ID of the storage volume.

cloudstring required

Specifies the underlying cloud provider. See this explanation for more details.

cloud_assigned_idstring required

The unique identifier of the storage volume issued by the underlying cloud provider.

regionstring required

Specifies the region.

namestring required

The name of the storage volume.

fixed_sizeboolean required

Denotes whether the volume is fixed in size or elastically scaling.

size_in_gbinteger required

Storage volume size in GB

cost_estimatestring required

The cost incurred by the instance. This only the cost via Shadeform. If the instance is deployed in your own cloud account, then all billing is through your cloud provider.

supports_multi_mountboolean required

Denotes whether the volume supports multiple instances mounting to it at the same time.

mounted_bystring required

The ID of the instance that is currently mounting the volume.

Example response

{
  "id": "78a0dd5a-dbb1-4568-b55c-5e7e0a8b0c40",
  "cloud": "hyperstack",
  "cloud_assigned_id": "13b057d7-e266-4869-985f-760fe75a78b3",
  "region": "canada-1",
  "name": "My storage volume",
  "fixed_size": true,
  "size_in_gb": 100,
  "cost_estimate": "103.4",
  "supports_multi_mount": true,
  "mounted_by": "13b057d7-e266-4869-985f-760fe75a78b3"
}