Volumes

Get all volumes

Changed on
get/v1/volumes

Request

  • Base URL: https://api.verda.com
  • URL: https://api.verda.com/v1/volumes
  • Auth: HTTP bearer

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_idobject 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_idobject
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

targetobject 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_pathobject required

Volume pseudo path. Unique identifier for your filesystem

create_directory_commandobject required

Create directory command

mount_commandobject required

Mount command

filesystem_to_fstab_commandobject 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": "50494c5e-3ec0-4681-a4d9-10a51d47a7ac",
    "instances": [
      {
        "id": "b6c33a1a-9d83-497d-8169-cab3097b99cc",
        "auto_rental_extension": null,
        "ip": "123.123.123.123",
        "instance_type": "4A100.88V",
        "status": "running",
        "os_volume_id": "08014786-b3df-48cd-87f4-db70c622d161",
        "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,
    "type": "NVMe",
    "location": "FIN-01",
    "ssh_key_ids": [
      "9d7be80c-a65a-4b26-8cf1-96ea77d3997a"
    ],
    "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"
      }
    ]
  }
]

Changes

  • 416768e2fdd7Revision changes
    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the / response's property type changed from string to object for status

  • c6bc656333bdRevision changes
    • info

      added the required property / to the response with the status