Volumes

Get all volumes that are in trash

get/v1/volumes/trash

Response

Returns a list of all volumes in trash

idstring required

Volume ID

instance_idstring required

Instance ID

instancesstring[] required

Instance info the volume is attached to

namestring required

Volume name

created_atstring required

Volume creation date

status'ordered' | 'attached' | 'attaching' | 'detached' | 'deleted' | 'cloning' | 'detaching' | 'deleting' | 'restoring' | 'created' | 'exported' | 'canceled' | 'canceling' required

Volume status

sizenumber required

Volume size in GB

is_os_volumeboolean required

Is OS volume

targetstring required

Volume target

type'HDD' | 'NVMe' | 'HDD_Shared' | 'NVMe_Shared' | 'NVMe_Local_Storage' | 'NVMe_Shared_Cluster' | 'NVMe_OS_Cluster' required

Volume type

locationstring required

Volume location

ssh_key_idsstring[] required

Array of SSH key IDs that are linked to the volume if it is an OS volume

contractstring required

Volume contract type

base_hourly_costnumber required

Volume base hourly cost

monthly_pricenumber required

Volume monthly price

currency'usd' | 'eur' required

Volume currency

deleted_atstring required

Volume deletion date

is_permanently_deletedboolean required

Is volume permanently deleted

Example response

[
  {
    "id": "93c471c1-0810-49f8-a073-a81f999331b6",
    "instance_id": "d3a79bb2-85da-4921-b1e5-dd21d0da4f82",
    "instances": [
      {
        "id": "d3a79bb2-85da-4921-b1e5-dd21d0da4f82",
        "auto_rental_extension": null,
        "ip": "123.123.123.123",
        "instance_type": "4A100.88V",
        "status": "running",
        "os_volume_id": "514409f3-9b84-4ced-9d92-9a772603f50b",
        "hostname": "hazy-star-swims-fin-01",
        "instance_template": {
          "instance_type": "4A100.88V",
          "cpu_cores": 128,
          "gpu_number": 4,
          "gpu_vram_gb": 80,
          "ram_gb": 512
        },
        "instance_model": {
          "code": "A100_80G",
          "manufacturer": "NVIDIA",
          "category": "GPU",
          "cluster_model_code": null
        }
      }
    ],
    "name": "OS-NVMe-84Ca37Jf",
    "created_at": "2024-07-08T19:19:54.247Z",
    "status": "attached",
    "size": 100,
    "is_os_volume": true,
    "target": "vda",
    "type": "NVMe",
    "location": "FIN-01",
    "ssh_key_ids": [
      "537f578e-e336-4fee-a034-5397c6955115"
    ],
    "contract": "LONG_TERM",
    "base_hourly_cost": 0.0273972602739726,
    "monthly_price": 20,
    "currency": "eur",
    "tags": [
      {
        "id": "tag_0aB1cD2eF3gH4iJ5kL6mN7",
        "key": "environment",
        "value": "production"
      }
    ],
    "deleted_at": "2025-01-10T11:35:47.633Z"
  }
]

Changes

Changed in 1 of the 11 revisions of this API.1

    • added the required property items/tags to the response with the 200 status

      response-required-property-added