Create

Create a New Block Storage Volume

client.gpuDroplets.volumes.create(, ?): VolumeCreateResponse { volume }

post/v2/volumes

To create a new volume, send a POST request to /v2/volumes. Optionally, a filesystem_type attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to Droplets without support for auto-mounting is not recommended.

ParametersExpand Collapse

VolumeCreateParams = VolumesExt4 | VolumesXfs

VolumeCreateParamsBase { name, region, size_gigabytes, 5 more }

name: string

A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter.

region: "ams1" | "ams2" | "ams3" | 12 more

The slug identifier for the region where the resource will initially be available.

Accepts one of the following:

"ams1"

"ams2"

"ams3"

"blr1"

"fra1"

"lon1"

"nyc1"

"nyc2"

"nyc3"

"sfo1"

"sfo2"

"sfo3"

"sgp1"

"tor1"

"syd1"

size_gigabytes: number

The size of the block storage volume in GiB (1024^3). This field does not apply when creating a volume from a snapshot.

description?: string

An optional free-form text field to describe a block storage volume.

filesystem_label?: string

The label applied to the filesystem. Labels for ext4 type filesystems may contain 16 characters while labels for xfs type filesystems are limited to 12 characters. May only be used in conjunction with filesystem_type.

maxLength16

filesystem_type?: string

The name of the filesystem type to be used on the volume. When provided, the volume will automatically be formatted to the specified filesystem type. Currently, the available options are ext4 and xfs. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to other Droplets is not recommended.

snapshot_id?: string

The unique identifier for the volume snapshot from which to create the volume.

tags?: Array<string> | null

A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.

Requires tag:create scope.

VolumesExt4 extends VolumeCreateParamsBase { name, region, size_gigabytes, 5 more }

VolumesXfs extends VolumeCreateParamsBase { name, region, size_gigabytes, 5 more }

ReturnsExpand Collapse

VolumeCreateResponse { volume }

volume?: Volume { id, created_at, description, 7 more }

id?: string

The unique identifier for the block storage volume.

created_at?: string

A time value given in ISO8601 combined date and time format that represents when the block storage volume was created.

description?: string

An optional free-form text field to describe a block storage volume.

droplet_ids?: Array<number> | null

An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.

filesystem_label?: string

The label currently applied to the filesystem.

filesystem_type?: string

The type of filesystem currently in-use on the volume.

name?: string

A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter.

region?: Region { available, features, name, 2 more }

The region that the block storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a block storage volume, the entire region object will be returned.

available: boolean

This is a boolean value that represents whether new Droplets can be created in this region.

features: Array<string>

This attribute is set to an array which contains features available in this region

name: string

The display name of the region. This will be a full name that is used in the control panel and other interfaces.

sizes: Array<string>

This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.

slug: string

A human-readable string that is used as a unique identifier for each region.

size_gigabytes?: number

The size of the block storage volume in GiB (1024^3). This field does not apply when creating a volume from a snapshot.

tags?: Array<string> | null

A flat array of tag names as strings applied to the resource.

Requires tag:read scope.

Create a New Block Storage Volume

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const volume = await client.gpuDroplets.volumes.create({
  name: 'ext4-example',
  region: 'nyc1',
  size_gigabytes: 10,
  description: 'Block store for examples',
  filesystem_label: 'ext4_volume_01',
  filesystem_type: 'ext4',
});

console.log(volume.volume);

{
  "volume": {
    "description": "Block store for examples",
    "filesystem_label": "example",
    "filesystem_type": "ext4",
    "name": "example",
    "size_gigabytes": 10,
    "tags": [
      "base-image",
      "prod"
    ]
  }
}

Returns Examples

{
  "volume": {
    "description": "Block store for examples",
    "filesystem_label": "example",
    "filesystem_type": "ext4",
    "name": "example",
    "size_gigabytes": 10,
    "tags": [
      "base-image",
      "prod"
    ]
  }
}