Give Feedback

snapshots_info

Generated on 30 Jun 2025 from digitalocean.cloud version v1.2.1

Synopsis

Retrieve a list of all of the snapshots in your account. View the API documentation at (https://docs.digitalocean.com/reference/api/api-reference/#operation/snapshots_list).

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`resource_type` str	Choices: `droplet` `volume`	Used to filter snapshots by a resource type.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Get snapshots
  digitalocean.cloud.snapshots_info:
    token: "{{ token }}"

- name: Get Droplet snapshots
  digitalocean.cloud.snapshots_info:
    token: "{{ token }}"
    type: droplet

- name: Get volume snapshots
  digitalocean.cloud.snapshots_info:
    token: "{{ token }}"
    type: volume

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Snapshots result information. Sample: `[ "Current snapshots", "No snapshots" ]`
`snapshots` list	always	Snapshots. Sample: `[ { "created_at": "2020-07-28T16:47:44Z", "id": "6372321", "min_disk_size": 25, "name": "web-01-1595954862243", "regions": [], "resource_id": "200776916", "resource_type": "droplet", "size_gigabytes": 2.34, "tags": [] } ]`

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str

always

Snapshots result information.
Sample:

[
  "Current snapshots",
  "No snapshots"
]

snapshots
list