Class BlockStorageService

Create a new Block Storage volume

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const request = {
  size_gigabytes: 10,
  name: 'example',
  description: 'Block store for examples',
  region: 'nyc1'
};
const volume = await client.blockStorage.createBlockStorage(request);

Create a snapshot from a Block Storage volume

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const snapshot = await client.blockStorage
   .createSnapshotFromVolume('volume-id', 'my-new-snapshot');

Delete a Block Storage volume by ID

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
await client.blockStorage.deleteBlockStorageById('volume-id');

Delete a Block Storage volume by name and region

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
await client.blockStorage.deleteBlockStorageByName('volume-name', 'nyc1');

List all of the Block Storage volumes available on your account

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const volumes = await client.blockStorage.getAllBlockStorage();

Get a single Block Storage volume by ID

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const volume = await client.blockStorage.getBlockStorageById('volume-id');

Get Block Storage volumes by name and region

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const volume = await client.blockStorage
   .getBlockStorageByName('volume-name', 'nyc1');

Get snapshots that have been created from a Block Storage volume

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const snapshots = await client.blockStorage
   .getSnapshotsForVolume('volume-id');