Volumes

Perform action on a volume or multiple volumes

Changed on
put/v1/volumes

Request

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

Request body

action'attach' | 'detach' | 'delete' | 'rename' | 'resize' | 'restore' | 'clone' | 'cancel' | 'create' | 'export' | 'transfer' required

Action to perform on the volume(s)

The clone action returns its destination volume ID: {"id":"..."}. Send a cancel action with that same ID to interrupt a cross-datacenter clone.

sizenumber

New volume size in GB. Can't be lower than current size

instance_idstring

Instance ID to attach the volume to, if the action is attach

instance_idsstring[]

Array of instance IDs to attach the volume to, if the action is attach

namestring

New volume name

typestring

Target volume type

is_permanentboolean

If deleting volume(s), delete them permanently

location_codestring

Target location code if cloning the volume

Example request

{
  "action": "detach",
  "size": 100,
  "instance_id": "3b1274b4-26fb-4692-b257-b9fe1f61dc21",
  "instance_ids": [
    "9c8be86c-5dd1-4a7f-9e1f-4a7e660e9ef5",
    "110ef5f4-3151-48da-afbb-3af4e3dd678e"
  ],
  "name": "volume-name",
  "type": "NVMe",
  "is_permanent": true,
  "location_code": "FIN-01"
}

Changes

  • 31918503bdd7Revision changes
    • warning

      deleted the header request parameter cf-connecting-ip

    • warning

      deleted the header request parameter user-agent

  • af37d33af0b7Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable