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
.
Servers
- https://api.digitalocean.com
Query parameters
Name | Type | Required | Description |
---|---|---|---|
page |
Integer | No |
Which 'page' of paginated results to return. Default value: 1 |
resource_type |
String | No |
Used to filter snapshots by a resource type. Possible values:
|
per_page |
Integer | No |
Number of items returned per page Default value: 20 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.