Skip to content
  • Auto
  • Light
  • Dark

Retrieve

Retrieve an Existing Snapshot
get/v2/snapshots/{snapshot_id}

To retrieve information about a snapshot, send a GET request to /v2/snapshots/$SNAPSHOT_ID.

The response will be a JSON object with a key called snapshot. The value of this will be an snapshot object containing the standard snapshot attributes.

Path Parameters
snapshot_idunion
number OR string

The ID of a Droplet snapshot.

Hide ParametersShow Parameters
UnionMember0number

The ID of a Droplet snapshot.

UnionMember1string

The ID of a volume snapshot.

Returns
snapshotidstringcreated_atstringmin_disk_sizenumbernamestringregionsarray of stringresource_idstringresource_typeenumsize_gigabytesnumbertagsarray of stringSnapshots
optional
curl https://api.digitalocean.com//v2/snapshots/$SNAPSHOT_ID \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "snapshot": {
    "id": "6372321",
    "created_at": "2020-07-28T16:47:44Z",
    "min_disk_size": 25,
    "name": "web-01-1595954862243",
    "regions": [
      "nyc3",
      "sfo3"
    ],
    "resource_id": "200776916",
    "resource_type": "droplet",
    "size_gigabytes": 2.34,
    "tags": [
      "web",
      "env:prod"
    ]
  }
}