List

List Snapshots for a Volume

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.

Path ParametersExpand Collapse

volume_id: string

formatuuid

Query ParametersExpand Collapse

page: optional number

Which 'page' of paginated results to return.

minimum1

per_page: optional number

Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

meta: MetaProperties { total }

Information about the response itself.

total: optional number

Number of objects returned by the request.

links: optional PageLinks { pages }

pages: optional ForwardLinks { last, next } or BackwardLinks { first, prev } or unknown

Accepts one of the following:

ForwardLinks = object { last, next }

last: optional string

URI of the last page of the results.

next: optional string

URI of the next page of the results.

BackwardLinks = object { first, prev }

first: optional string

URI of the first page of the results.

prev: optional string

URI of the previous page of the results.

UnionMember2 = unknown

snapshots: optional array of Snapshots { id, created_at, min_disk_size, 6 more }

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.

formatdate-time

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 of string

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" or "volume"

The type of resource that the snapshot originated from.

Accepts one of the following:

"droplet"

"volume"

size_gigabytes: number

The billable size of the snapshot in gigabytes.

formatfloat

tags: array of string

An array of Tags the snapshot has been tagged with.

Requires tag:read scope.

List Snapshots for a Volume

curl https://api.digitalocean.com/v2/volumes/$VOLUME_ID/snapshots \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"

{
  "meta": {
    "total": 1
  },
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  },
  "snapshots": [
    {
      "id": "8eb4d51a-873f-11e6-96bf-000f53315a41",
      "created_at": "2020-09-30T18:56:12Z",
      "min_disk_size": 10,
      "name": "big-data-snapshot1475261752",
      "regions": [
        "nyc1"
      ],
      "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41",
      "resource_type": "volume",
      "size_gigabytes": 0,
      "tags": [
        "string"
      ]
    }
  ]
}

Returns Examples

{
  "meta": {
    "total": 1
  },
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  },
  "snapshots": [
    {
      "id": "8eb4d51a-873f-11e6-96bf-000f53315a41",
      "created_at": "2020-09-30T18:56:12Z",
      "min_disk_size": 10,
      "name": "big-data-snapshot1475261752",
      "regions": [
        "nyc1"
      ],
      "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41",
      "resource_type": "volume",
      "size_gigabytes": 0,
      "tags": [
        "string"
      ]
    }
  ]
}