Sign in

v1

latestSwagger 2.02026-08-04232286653.5 KB
Disks

Returns details for a single disk in the project.

Size of disk will be in gibibytes (GiB)

get/projects/{project_id}/storage/disks/{disk_id}

Path parameters

project_idstring required

ID of the project that owns the disk.

disk_idstring required

ID of the disk.

Response

block_sizeinteger required

Block size of the disk, in bytes: 512 or 4096.

created_atstring required

Creation timestamp of the disk, in RFC3339 format.

dns_namestring

DNS name used to mount the disk. Populated only for shared-volume disks.

idstring required

ID of the disk.

locationstring required

Location where the disk is provisioned.

namestring required

Name of the disk.

serial_numberstring required

Serial number assigned to the disk.

sizestring required

Storage capacity of the disk, given as a size and unit in the format [Size][Unit], for example 100GiB or 1TiB.

typestring required

Type of the disk: persistent-ssd or shared-volume.

updated_atstring required

Last update timestamp of the disk, in RFC3339 format.

vipsstring[]

Virtual IP addresses used to mount the disk. Populated only for shared-volume disks.

Example response

{
  "attached_to": [
    {
      "vm_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "block_size": 4096,
  "created_at": "2021-12-03T19:58:34Z",
  "dns_name": "nfs.crusoecloudcompute.com",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "location": "us-northcentral1-a",
  "name": "my-disk",
  "serial_number": "96FD14FDBCF7E21E8EC",
  "size": "10GiB",
  "type": "persistent-ssd",
  "updated_at": "2021-12-03T19:58:34Z",
  "vips": [
    "1.2.3.4",
    "1.2.3.8"
  ]
}