Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

List

List All Snapshots
gpu_droplets.snapshots.list(SnapshotListParams**kwargs) -> metaMetaPropertieslinksPageLinkssnapshotslistSnapshotListResponse
get/v2/snapshots

To list all of the snapshots available on your account, send a GET request to /v2/snapshots.

The response will be a JSON object with a key called snapshots. This will be set to an array of snapshot objects, each of which will contain the standard snapshot attributes.

Filtering Results by Resource Type

It's possible to request filtered results by including certain query parameters.

List Droplet Snapshots

To retrieve only snapshots based on Droplets, include the resource_type query parameter set to droplet. For example, /v2/snapshots?resource_type=droplet.

List Volume Snapshots

To retrieve only snapshots based on volumes, include the resource_type query parameter set to volume. For example, /v2/snapshots?resource_type=volume.

Parameters
pageint
optional

Which 'page' of paginated results to return.

minimum1
per_pageint
optional

Number of items returned per page

minimum1
maximum200
resource_typeliteral
optional
Literal["droplet", "volume"]

Used to filter snapshots by a resource type.

Hide ParametersShow Parameters
"droplet"
"volume"
Returns
SnapshotListResponseclass
Hide ParametersShow Parameters
metatotalintMetaProperties

Information about the response itself.

snapshotslist
optional
Optional[List[idstrcreated_atdatetimemin_disk_sizeintnamestrregionslistresource_idstrresource_typeliteralsize_gigabytesfloattagslistSnapshots]]
Hide ParametersShow Parameters
idstr

The unique identifier for the snapshot.

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.

resource_idstr

The unique identifier for the resource that the snapshot originated from.

resource_typeliteral
Literal["droplet", "volume"]

The type of resource that the snapshot originated from.

Hide ParametersShow Parameters
"droplet"
"volume"
size_gigabytesfloat

The billable size of the snapshot in gigabytes.

formatfloat
tagslist
Optional[List[str]]

An array of Tags the snapshot has been tagged with.

Requires tag:read scope.

from do_gradientai import GradientAI

client = GradientAI()
snapshots = client.gpu_droplets.snapshots.list()
print(snapshots.meta)
200 Example
{
  "snapshots": [
    {
      "id": "6372321",
      "name": "web-01-1595954862243",
      "created_at": "2020-07-28T16:47:44Z",
      "regions": [
        "nyc3",
        "sfo3"
      ],
      "resource_id": "200776916",
      "resource_type": "droplet",
      "min_disk_size": 25,
      "size_gigabytes": 2.34,
      "tags": [
        "web",
        "env:prod"
      ]
    },
    {
      "id": "fbe805e8-866b-11e6-96bf-000f53315a41",
      "name": "pvc-01-1595954862243",
      "created_at": "2019-09-28T23:14:30Z",
      "regions": [
        "nyc1"
      ],
      "resource_id": "89bcc42f-85cf-11e6-a004-000f53315871",
      "resource_type": "volume",
      "min_disk_size": 2,
      "size_gigabytes": 0.1008,
      "tags": [
        "k8s"
      ]
    }
  ],
  "links": {},
  "meta": {
    "total": 2
  }
}