List Snapshots

List Snapshots for a Droplet

gpu_droplets.list_snapshots(intdroplet_id, GPUDropletListSnapshotsParams**kwargs) -> metaMetaPropertieslinksPageLinkssnapshotslistGPUDropletListSnapshotsResponse

get/v2/droplets/{droplet_id}/snapshots

To retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/snapshots.

You will get back a JSON object that has a snapshots key. This will be set to an array of snapshot objects, each of which contain the standard Droplet snapshot attributes.

Parameters

droplet_idint

minimum1

pageint

optional

Which 'page' of paginated results to return.

minimum1

per_pageint

optional

Number of items returned per page

minimum1

maximum200

Returns

GPUDropletListSnapshotsResponseclass

Hide ParametersShow Parameters

metatotalintMetaProperties

Information about the response itself.

linksPageLinks

optional

snapshotslist

optional

Optional[List[Snapshot]]

Hide ParametersShow Parameters

idint

The unique identifier for the snapshot or backup.

created_atdatetime

A time value given in ISO8601 combined date and time format that represents when the snapshot was created.

formatdate-time

min_disk_sizeint

The minimum size in GB required for a volume or Droplet to use this snapshot.

namestr

A human-readable name for the snapshot.

regionslist

List[str]

An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values.

size_gigabytesfloat

The billable size of the snapshot in gigabytes.

formatfloat

typeliteral

Literal["snapshot", "backup"]

Describes the kind of image. It may be one of snapshot or backup. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup.

Hide ParametersShow Parameters

"snapshot"

"backup"

HTTPPython

from do_gradientai import GradientAI

client = GradientAI()
response = client.gpu_droplets.list_snapshots(
    droplet_id=3164444,
)
print(response.meta)

200 Example

{
  "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": 6372321,
      "created_at": "2020-07-28T16:47:44Z",
      "min_disk_size": 25,
      "name": "web-01-1595954862243",
      "regions": [
        "nyc3",
        "sfo3"
      ],
      "size_gigabytes": 2.34,
      "type": "snapshot"
    }
  ]
}