# Volumes ## Create `client.gpuDroplets.volumes.create(VolumeCreateParamsbody, RequestOptionsoptions?): VolumeCreateResponse` **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. ### Parameters - `VolumeCreateParams = VolumesExt4 | VolumesXfs` - `VolumeCreateParamsBase` - `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. - `"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. - `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 | 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` - `VolumesXfs extends VolumeCreateParamsBase` ### Returns - `VolumeCreateResponse` - `volume?: Volume` - `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 | 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` 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` 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` 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 | null` A flat array of tag names as strings applied to the resource.

Requires `tag:read` scope. ### Example ```typescript 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); ``` ## Retrieve `client.gpuDroplets.volumes.retrieve(stringvolumeID, RequestOptionsoptions?): VolumeRetrieveResponse` **get** `/v2/volumes/{volume_id}` To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`. ### Parameters - `volumeID: string` ### Returns - `VolumeRetrieveResponse` - `volume?: Volume` - `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 | 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` 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` 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` 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 | null` A flat array of tag names as strings applied to the resource.

Requires `tag:read` scope. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const volume = await client.gpuDroplets.volumes.retrieve('7724db7c-e098-11e5-b522-000f53304e51'); console.log(volume.volume); ``` ## List `client.gpuDroplets.volumes.list(VolumeListParamsquery?, RequestOptionsoptions?): VolumeListResponse` **get** `/v2/volumes` To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`. ## Filtering Results ### By Region The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1` ### By Name It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`. **Note:** You can only create one volume per region with the same name. ### By Name and Region It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. ### Parameters - `query: VolumeListParams` - `name?: string` The block storage volume's name. - `page?: number` Which 'page' of paginated results to return. - `per_page?: number` Number of items returned per page - `region?: "ams1" | "ams2" | "ams3" | 12 more` The slug identifier for the region where the resource is available. - `"ams1"` - `"ams2"` - `"ams3"` - `"blr1"` - `"fra1"` - `"lon1"` - `"nyc1"` - `"nyc2"` - `"nyc3"` - `"sfo1"` - `"sfo2"` - `"sfo3"` - `"sgp1"` - `"tor1"` - `"syd1"` ### Returns - `VolumeListResponse` - `meta: MetaProperties` Information about the response itself. - `total?: number` Number of objects returned by the request. - `volumes: Array` Array of volumes. - `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 | 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` 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` 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` 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 | null` A flat array of tag names as strings applied to the resource.

Requires `tag:read` scope. - `links?: PageLinks` - `pages?: ForwardLinks | BackwardLinks | unknown` - `ForwardLinks` - `last?: string` URI of the last page of the results. - `next?: string` URI of the next page of the results. - `BackwardLinks` - `first?: string` URI of the first page of the results. - `prev?: string` URI of the previous page of the results. - `unknown` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const volumes = await client.gpuDroplets.volumes.list(); console.log(volumes.meta); ``` ## Delete `client.gpuDroplets.volumes.delete(stringvolumeID, RequestOptionsoptions?): void` **delete** `/v2/volumes/{volume_id}` To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to `/v2/volumes/$VOLUME_ID`. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. ### Parameters - `volumeID: string` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); await client.gpuDroplets.volumes.delete('7724db7c-e098-11e5-b522-000f53304e51'); ``` ## Delete By Name `client.gpuDroplets.volumes.deleteByName(VolumeDeleteByNameParamsparams?, RequestOptionsoptions?): void` **delete** `/v2/volumes` Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. ### Parameters - `params: VolumeDeleteByNameParams` - `name?: string` The block storage volume's name. - `region?: "ams1" | "ams2" | "ams3" | 12 more` The slug identifier for the region where the resource is available. - `"ams1"` - `"ams2"` - `"ams3"` - `"blr1"` - `"fra1"` - `"lon1"` - `"nyc1"` - `"nyc2"` - `"nyc3"` - `"sfo1"` - `"sfo2"` - `"sfo3"` - `"sgp1"` - `"tor1"` - `"syd1"` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); await client.gpuDroplets.volumes.deleteByName(); ``` # Actions ## Retrieve `client.gpuDroplets.volumes.actions.retrieve(numberactionID, ActionRetrieveParamsparams, RequestOptionsoptions?): ActionRetrieveResponse` **get** `/v2/volumes/{volume_id}/actions/{action_id}` To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`. ### Parameters - `actionID: number` - `params: ActionRetrieveParams` - `volume_id: string` Path param: The ID of the block storage volume. - `page?: number` Query param: Which 'page' of paginated results to return. - `per_page?: number` Query param: Number of items returned per page ### Returns - `ActionRetrieveResponse` - `action?: VolumeAction` - `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. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const action = await client.gpuDroplets.volumes.actions.retrieve(36804636, { volume_id: '7724db7c-e098-11e5-b522-000f53304e51', }); console.log(action.action); ``` ## List `client.gpuDroplets.volumes.actions.list(stringvolumeID, ActionListParamsquery?, RequestOptionsoptions?): ActionListResponse` **get** `/v2/volumes/{volume_id}/actions` To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`. ### Parameters - `volumeID: string` - `query: ActionListParams` - `page?: number` Which 'page' of paginated results to return. - `per_page?: number` Number of items returned per page ### Returns - `ActionListResponse` - `meta: MetaProperties` Information about the response itself. - `total?: number` Number of objects returned by the request. - `actions?: Array` - `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. - `links?: PageLinks` - `pages?: ForwardLinks | BackwardLinks | unknown` - `ForwardLinks` - `last?: string` URI of the last page of the results. - `next?: string` URI of the next page of the results. - `BackwardLinks` - `first?: string` URI of the first page of the results. - `prev?: string` URI of the previous page of the results. - `unknown` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const actions = await client.gpuDroplets.volumes.actions.list('7724db7c-e098-11e5-b522-000f53304e51'); console.log(actions.meta); ``` ## Initiate By ID `client.gpuDroplets.volumes.actions.initiateByID(stringvolumeID, ActionInitiateByIDParamsparams, RequestOptionsoptions?): ActionInitiateByIDResponse` **post** `/v2/volumes/{volume_id}/actions` To initiate an action on a block storage volume by Id, send a POST request to `~/v2/volumes/$VOLUME_ID/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` | | 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](https://docs.digitalocean.com/products/volumes/how-to/mount/) is required. ## Remove a Block Storage Volume from a Droplet | Attribute | Details | | ---------- | ------------------------------------------------------------------- | | type | This must be `detach` | | droplet_id | Set to the Droplet's ID | | region | Set to the slug representing the region where the volume is located | ## Resize a Volume | Attribute | Details | | -------------- | ------------------------------------------------------------------- | | type | This must be `resize` | | size_gigabytes | The new size of the block storage volume in GiB (1024^3) | | region | Set to the slug representing the region where the volume is located | Volumes may only be resized upwards. The maximum size for a volume is 16TiB. ### Parameters - `volumeID: string` - `ActionInitiateByIDParams = VolumeActionPostAttach | VolumeActionPostDetach | VolumeActionPostResize` - `ActionInitiateByIDParamsBase` - `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. - `"attach"` - `"detach"` - `"resize"` - `page?: number` Query param: Which 'page' of paginated results to return. - `per_page?: number` Query param: Number of items returned per page - `region?: "ams1" | "ams2" | "ams3" | 12 more` Body param: The slug identifier for the region where the resource will initially be available. - `"ams1"` - `"ams2"` - `"ams3"` - `"blr1"` - `"fra1"` - `"lon1"` - `"nyc1"` - `"nyc2"` - `"nyc3"` - `"sfo1"` - `"sfo2"` - `"sfo3"` - `"sgp1"` - `"tor1"` - `"syd1"` - `tags?: Array | 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 ActionInitiateByIDParamsBase` - `VolumeActionPostDetach extends ActionInitiateByIDParamsBase` - `VolumeActionPostResize extends ActionInitiateByIDParamsBase` ### Returns - `ActionInitiateByIDResponse` - `action?: VolumeAction` - `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. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const response = await client.gpuDroplets.volumes.actions.initiateByID( '7724db7c-e098-11e5-b522-000f53304e51', { droplet_id: 11612190, type: 'attach', region: 'nyc1', tags: ['aninterestingtag'] }, ); console.log(response.action); ``` ## Initiate By Name `client.gpuDroplets.volumes.actions.initiateByName(ActionInitiateByNameParamsparams, RequestOptionsoptions?): ActionInitiateByNameResponse` **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](https://docs.digitalocean.com/products/volumes/how-to/mount/) 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 | ### Parameters - `ActionInitiateByNameParams = VolumeActionPostAttach | VolumeActionPostDetach` - `ActionInitiateByNameParamsBase` - `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. - `"attach"` - `"detach"` - `"resize"` - `page?: number` Query param: Which 'page' of paginated results to return. - `per_page?: number` Query param: Number of items returned per page - `region?: "ams1" | "ams2" | "ams3" | 12 more` Body param: The slug identifier for the region where the resource will initially be available. - `"ams1"` - `"ams2"` - `"ams3"` - `"blr1"` - `"fra1"` - `"lon1"` - `"nyc1"` - `"nyc2"` - `"nyc3"` - `"sfo1"` - `"sfo2"` - `"sfo3"` - `"sgp1"` - `"tor1"` - `"syd1"` - `tags?: Array | 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` - `VolumeActionPostDetach extends ActionInitiateByNameParamsBase` ### Returns - `ActionInitiateByNameResponse` - `action?: VolumeAction` - `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. ### Example ```typescript 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); ``` ## Domain Types ### Volume Action - `VolumeAction extends Action` - `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. # Snapshots ## Create `client.gpuDroplets.volumes.snapshots.create(stringvolumeID, SnapshotCreateParamsbody, RequestOptionsoptions?): SnapshotCreateResponse` **post** `/v2/volumes/{volume_id}/snapshots` To create a snapshot from a volume, sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`. ### Parameters - `volumeID: string` - `body: SnapshotCreateParams` - `name: string` A human-readable name for the volume snapshot. - `tags?: Array | 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. ### Returns - `SnapshotCreateResponse` - `snapshot?: Snapshots` - `id: string` The unique identifier for the snapshot. - `created_at: string` A time value given in ISO8601 combined date and time format that represents when the snapshot was created. - `min_disk_size: number` The minimum size in GB required for a volume or Droplet to use this snapshot. - `name: string` A human-readable name for the snapshot. - `regions: Array` An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. - `resource_id: string` The unique identifier for the resource that the snapshot originated from. - `resource_type: "droplet" | "volume"` The type of resource that the snapshot originated from. - `"droplet"` - `"volume"` - `size_gigabytes: number` The billable size of the snapshot in gigabytes. - `tags: Array | null` An array of Tags the snapshot has been tagged with.

Requires `tag:read` scope. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const snapshot = await client.gpuDroplets.volumes.snapshots.create('7724db7c-e098-11e5-b522-000f53304e51', { name: 'big-data-snapshot1475261774', }); console.log(snapshot.snapshot); ``` ## Retrieve `client.gpuDroplets.volumes.snapshots.retrieve(stringsnapshotID, RequestOptionsoptions?): SnapshotRetrieveResponse` **get** `/v2/volumes/snapshots/{snapshot_id}` To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. ### Parameters - `snapshotID: string` ### Returns - `SnapshotRetrieveResponse` - `snapshot?: Snapshots` - `id: string` The unique identifier for the snapshot. - `created_at: string` A time value given in ISO8601 combined date and time format that represents when the snapshot was created. - `min_disk_size: number` The minimum size in GB required for a volume or Droplet to use this snapshot. - `name: string` A human-readable name for the snapshot. - `regions: Array` An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. - `resource_id: string` The unique identifier for the resource that the snapshot originated from. - `resource_type: "droplet" | "volume"` The type of resource that the snapshot originated from. - `"droplet"` - `"volume"` - `size_gigabytes: number` The billable size of the snapshot in gigabytes. - `tags: Array | null` An array of Tags the snapshot has been tagged with.

Requires `tag:read` scope. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const snapshot = await client.gpuDroplets.volumes.snapshots.retrieve('fbe805e8-866b-11e6-96bf-000f53315a41'); console.log(snapshot.snapshot); ``` ## List `client.gpuDroplets.volumes.snapshots.list(stringvolumeID, SnapshotListParamsquery?, RequestOptionsoptions?): SnapshotListResponse` **get** `/v2/volumes/{volume_id}/snapshots` To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`. ### Parameters - `volumeID: string` - `query: SnapshotListParams` - `page?: number` Which 'page' of paginated results to return. - `per_page?: number` Number of items returned per page ### Returns - `SnapshotListResponse` - `meta: MetaProperties` Information about the response itself. - `total?: number` Number of objects returned by the request. - `links?: PageLinks` - `pages?: ForwardLinks | BackwardLinks | unknown` - `ForwardLinks` - `last?: string` URI of the last page of the results. - `next?: string` URI of the next page of the results. - `BackwardLinks` - `first?: string` URI of the first page of the results. - `prev?: string` URI of the previous page of the results. - `unknown` - `snapshots?: Array` - `id: string` The unique identifier for the snapshot. - `created_at: string` A time value given in ISO8601 combined date and time format that represents when the snapshot was created. - `min_disk_size: number` The minimum size in GB required for a volume or Droplet to use this snapshot. - `name: string` A human-readable name for the snapshot. - `regions: Array` An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. - `resource_id: string` The unique identifier for the resource that the snapshot originated from. - `resource_type: "droplet" | "volume"` The type of resource that the snapshot originated from. - `"droplet"` - `"volume"` - `size_gigabytes: number` The billable size of the snapshot in gigabytes. - `tags: Array | null` An array of Tags the snapshot has been tagged with.

Requires `tag:read` scope. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const snapshots = await client.gpuDroplets.volumes.snapshots.list('7724db7c-e098-11e5-b522-000f53304e51'); console.log(snapshots.meta); ``` ## Delete `client.gpuDroplets.volumes.snapshots.delete(stringsnapshotID, RequestOptionsoptions?): void` **delete** `/v2/volumes/snapshots/{snapshot_id}` To delete a volume snapshot, send a DELETE request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. ### Parameters - `snapshotID: string` ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); await client.gpuDroplets.volumes.snapshots.delete('fbe805e8-866b-11e6-96bf-000f53315a41'); ```