SHshadeform

/volumes/{id}/info

Changed on

Get details for the specified storage volume.

get/volumes/{id}/info

Request

  • Base URL
    https://api.shadeform.ai/v1
  • URL
    https://api.shadeform.ai/v1/volumes/{id}/info
  • Auth
    API key in header X-API-KEY

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"
}

Changes

  • 4e81900e8957Revision changes
    • info

      removed the amaya enum value from the response property for the response status

    • info

      removed the boostrun enum value from the response property for the response status

    • info

      removed the crusoe enum value from the response property for the response status

    • info

      removed the cudo enum value from the response property for the response status

    • info

      removed the datacrunch enum value from the response property for the response status

    • info

      removed the denvr enum value from the response property for the response status

    • info

      removed the digitalocean enum value from the response property for the response status

    • info

      removed the evergreen enum value from the response property for the response status

    • info

      removed the excesssupply enum value from the response property for the response status

    • info

      removed the fpt enum value from the response property for the response status

    • info

      removed the horizon enum value from the response property for the response status

    • info

      removed the hotaisle enum value from the response property for the response status

    • info

      removed the hydra enum value from the response property for the response status

    • info

      removed the hyperstack enum value from the response property for the response status

    • info

      removed the imwt enum value from the response property for the response status

    • info

      removed the ionstream enum value from the response property for the response status

    • info

      removed the lambdalabs enum value from the response property for the response status

    • info

      removed the latitude enum value from the response property for the response status

    • info

      removed the massedcompute enum value from the response property for the response status

    • info

      removed the nebius enum value from the response property for the response status

    • info

      removed the paperspace enum value from the response property for the response status

    • info

      removed the scaleway enum value from the response property for the response status

    • info

      removed the tcm enum value from the response property for the response status

    • info

      removed the verda enum value from the response property for the response status

    • info

      removed the voltagepark enum value from the response property for the response status

    • info

      removed the vultr enum value from the response property for the response status

    • info

      removed the whitefiber enum value from the response property for the response status

  • 3d8ab648c278Revision changes
    • warning

      added the new verda enum value to the response property for the response status