GET
/
volumes
/
{id}
/
info
curl --request GET \
  --url https://api.shadeform.ai/v1/volumes/{id}/info \
  --header 'X-API-KEY: <api-key>'
{
  "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"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

The volume id.

Response

200 - application/json
Return a volume object.
​
id
string
required

The ID of the storage volume.

Example:

"78a0dd5a-dbb1-4568-b55c-5e7e0a8b0c40"

​
cloud
enum<string>
required

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

Available options:
aws,
azure,
lambdalabs,
tensordock,
runpod,
latitude,
jarvislabs,
oblivus,
paperspace,
datacrunch,
massedcompute,
vultr
Example:

"hyperstack"

​
cloud_assigned_id
string
required

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

Example:

"13b057d7-e266-4869-985f-760fe75a78b3"

​
region
string
required

Specifies the region.

Example:

"canada-1"

​
name
string
required

The name of the storage volume.

Example:

"My storage volume"

​
fixed_size
boolean
required

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

Example:

true

​
size_in_gb
integer
required

Storage volume size in GB

Example:

100

​
cost_estimate
string
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.

Example:

"103.4"

​
supports_multi_mount
boolean
required

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

Example:

true

​
mounted_by
string
required

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

Example:

"13b057d7-e266-4869-985f-760fe75a78b3"