Sign in
latestOpenAPI 3.1.02026-08-23100133183.1 KB

0d66c7340876

Volumes

Get all volumes

get/v1/volumes

Query parameters

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

Get volumes with this status. Optional

Response

Returns a list of all volumes

Rate limits

This endpoint is rate limited to 120 requests per minute per project.

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

created_by_user_idstring
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

pseudo_pathstring required

Volume pseudo path. Unique identifier for your filesystem

create_directory_commandstring required

Create directory command

mount_commandstring required

Mount command

filesystem_to_fstab_commandstring required

Filesystem to fstab command

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

long_termobject required

Long term contract details

Example response

[
  {
    "id": "5a699965-7deb-430b-8316-64044b1fc128",
    "instance_id": "bc52f4db-4ee3-4927-a906-33caa76ae4ba",
    "instances": [
      {
        "id": "bc52f4db-4ee3-4927-a906-33caa76ae4ba",
        "auto_rental_extension": null,
        "ip": "123.123.123.123",
        "instance_type": "4A100.88V",
        "status": "running",
        "os_volume_id": "56f72e4d-b29a-415b-b073-7ef6e76abd24",
        "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",
    "created_by_user_id": "7dfc2631-0158-4f74-93f6-6b46dcb90fef",
    "status": "attached",
    "size": 100,
    "is_os_volume": true,
    "target": "vda",
    "type": "NVMe",
    "location": "FIN-01",
    "ssh_key_ids": [
      "cc9d7a1b-3b03-4a8b-a75d-b40bbd051298"
    ],
    "pseudo_path": "volume-84Ca37Jf",
    "create_directory_command": "mkdir -p /mnt/volume",
    "mount_command": "mount -t nfs -o nconnect=16 nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume",
    "filesystem_to_fstab_command": "grep -qxF 'nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume nfs defaults 0 0' /etc/fstab || echo 'nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume nfs defaults 0 0' | sudo tee -a /etc/fstab",
    "contract": "LONG_TERM",
    "base_hourly_cost": 0.0273972602739726,
    "monthly_price": 20,
    "currency": "eur",
    "long_term": {
      "end_date": "2025-01-08T19:34:16.663Z",
      "long_term_period": "3 months",
      "discount_percentage": 14,
      "auto_rental_extension": false,
      "next_period_price": 49.93356,
      "current_period_price": 49.93356
    },
    "tags": [
      {
        "id": "tag_0aB1cD2eF3gH4iJ5kL6mN7",
        "key": "environment",
        "value": "production"
      }
    ]
  }
]