Sign in
latestOpenAPI 3.1.02026-08-23100133183.1 KB

0d66c7340876

Volumes

Create volume

post/v1/volumes

Headers

user-agentstring required
cf-connecting-ipstring required

Request body

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

Volume type

location_codestring required

Location code

sizenumber required

Volume size in GB

instance_idstring

Instance ID to attach the volume to

instance_idsstring[]

Array of instance IDs to attach the volume to

namestring required

Volume name

Example request

{
  "type": "NVMe",
  "location_code": "FIN-01",
  "size": 50,
  "instance_id": "1c9eb845-76a6-44dc-8c9b-44d0a6c0bba6",
  "instance_ids": [
    "c99be97c-98c2-4c57-aadd-f1d058d581a4",
    "5e156eeb-9ff9-4f04-8052-c9a7f711da81"
  ],
  "name": "my-volume",
  "tags": [
    {
      "key": "environment",
      "value": "production"
    }
  ]
}

Response

Volume ID