Initiate By Name

Initiate A Block Storage Action By Volume Name

client.gpuDroplets.volumes.actions.initiateByName(, ?): ActionInitiateByNameResponse { action }

post/v2/volumes/actions

To initiate an action on a block storage volume by Name, send a POST request to ~/v2/volumes/actions. The body should contain the appropriate attributes for the respective action.

Attach a Block Storage Volume to a Droplet

Attribute	Details
type	This must be `attach`
volume_name	The name of the block storage volume
droplet_id	Set to the Droplet's ID
region	Set to the slug representing the region where the volume is located

Each volume may only be attached to a single Droplet. However, up to fifteen volumes may be attached to a Droplet at a time. Pre-formatted volumes will be automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018 when attached. On older Droplets, additional configuration is required.

Remove a Block Storage Volume from a Droplet

Attribute	Details
type	This must be `detach`
volume_name	The name of the block storage volume
droplet_id	Set to the Droplet's ID
region	Set to the slug representing the region where the volume is located

ParametersExpand Collapse

ActionInitiateByNameParams = VolumeActionPostAttach | VolumeActionPostDetach

ActionInitiateByNameParamsBase { droplet_id, type, page, 3 more }

droplet_id: number

Body param: The unique identifier for the Droplet the volume will be attached or detached from.

type: "attach" | "detach" | "resize"

Body param: The volume action to initiate.

Accepts one of the following:

"attach"

"detach"

"resize"

page?: number

Query param: Which 'page' of paginated results to return.

minimum1

per_page?: number

Query param: Number of items returned per page

minimum1

maximum200

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

Body param: 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"

tags?: Array<string> | null

Body param: 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.

VolumeActionPostAttach extends ActionInitiateByNameParamsBase { droplet_id, type, page, 3 more }

VolumeActionPostDetach extends ActionInitiateByNameParamsBase { droplet_id, type, page, 3 more }

ReturnsExpand Collapse

ActionInitiateByNameResponse { action }

action?: VolumeAction { resource_id, type }

resource_id?: number | null

type?: string

This is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.

Initiate A Block Storage Action By Volume Name

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const response = await client.gpuDroplets.volumes.actions.initiateByName({
  droplet_id: 11612190,
  type: 'attach',
  region: 'nyc1',
  tags: ['aninterestingtag'],
});

console.log(response.action);

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "attach_volume",
    "started_at": "2020-11-12T17:51:03Z",
    "completed_at": "2020-11-12T17:51:14Z",
    "resource_type": "volume",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}

Returns Examples

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "attach_volume",
    "started_at": "2020-11-12T17:51:03Z",
    "completed_at": "2020-11-12T17:51:14Z",
    "resource_type": "volume",
    "region": {
      "name": "New York 1",
      "slug": "nyc1",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "available": true
    },
    "region_slug": "nyc1"
  }
}