Skip to main content

volume_snapshots

Overview

Namevolume_snapshots
TypeResource
Iddigitalocean.block_storage.volume_snapshots

Fields

NameDatatypeDescription
idstringThe unique identifier for the snapshot.
namestringA human-readable name for the snapshot.
created_atstringA time value given in ISO8601 combined date and time format that represents when the snapshot was created.
min_disk_sizeintegerThe minimum size in GB required for a volume or Droplet to use this snapshot.
regionsarrayAn array of the regions that the snapshot is available in. The regions are represented by their identifying slug values.
resource_idstringThe unique identifier for the resource that the snapshot originated from.
resource_typestringThe type of resource that the snapshot originated from.
size_gigabytesnumberThe billable size of the snapshot in gigabytes.
tagsarrayAn array of Tags the snapshot has been tagged with.

Methods

NameAccessible byRequired ParamsDescription
volumeSnapshots_get_byIdSELECTsnapshot_idTo retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.

volumeSnapshots_listSELECTvolume_idTo retrieve the snapshots that have been created from a volume, send a GET request to /v2/volumes/$VOLUME_ID/snapshots.

volumeSnapshots_createINSERTvolume_id, data__nameTo create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.
volumeSnapshots_delete_byIdDELETEsnapshot_idTo delete a volume snapshot, send a DELETE request to
/v2/snapshots/$SNAPSHOT_ID.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
_volumeSnapshots_get_byIdEXECsnapshot_idTo retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.

_volumeSnapshots_listEXECvolume_idTo retrieve the snapshots that have been created from a volume, send a GET request to /v2/volumes/$VOLUME_ID/snapshots.