Give Feedback

snapshot

Generated on 22 May 2025 from digitalocean.cloud version v1.2.1

Synopsis

Delete snapshots. View the delete API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/snapshots_delete.

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.
`snapshot_id` str		Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot.
`snapshot_name` str		The name of an existing snapshot. The module will fail if there is more than one by the same name, use `snapshot`id).
`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: Delete Droplet snapshot
  digitalocean.cloud.snapshot:
    token: "{{ token }}"
    state: absent
    snapshot_id: 11223344

- name: Delete volume snapshot
  digitalocean.cloud.snapshot:
    token: "{{ token }}"
    state: absent
    snapshot_id: fbe805e8-866b-11e6-96bf-000f53315a41

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	DigitalOcean volume information. Sample: `[ "Deleted snapshot 125349720", "Deleted snapshot test-snapshot-1", "Snapshot 125349720 would be deleted", "Snapshot test-snapshot-1 would be deleted", "Snapshot 125349720 not found", "Snapshot test-snapshot-1 not found" ]`
`snapshot` dict	always	Snapshot information. 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

DigitalOcean volume information.
Sample:

[
  "Deleted snapshot 125349720",
  "Deleted snapshot test-snapshot-1",
  "Snapshot 125349720 would be deleted",
  "Snapshot test-snapshot-1 would be deleted",
  "Snapshot 125349720 not found",
  "Snapshot test-snapshot-1 not found"
]

snapshot
dict