Actions

API Reference

GPU Droplets

Volumes

Actions

Initiate A Block Storage Action By Volume Id

client.gpuDroplets.volumes.actions.initiateByID(stringvolumeID, ActionInitiateByIDParamsparams, RequestOptionsoptions?): ActionInitiateByIDResponse { action }

post/v2/volumes/{volume_id}/actions

Initiate A Block Storage Action By Volume Name

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

post/v2/volumes/actions

List All Actions for a Volume

client.gpuDroplets.volumes.actions.list(stringvolumeID, ActionListParams { page, per_page } query?, RequestOptionsoptions?): ActionListResponse { meta, actions, links }

get/v2/volumes/{volume_id}/actions

Retrieve an Existing Volume Action

client.gpuDroplets.volumes.actions.retrieve(numberactionID, ActionRetrieveParams { volume_id, page, per_page } params, RequestOptionsoptions?): ActionRetrieveResponse { action }

get/v2/volumes/{volume_id}/actions/{action_id}

ModelsExpand Collapse

VolumeAction extends Action { id, completed_at, region, 6 more } { 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.