Create

Create Snapshot from a Volume

post/v2/volumes/{volume_id}/snapshots

To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.

Path ParametersExpand Collapse

volume_id: string

formatuuid

Body ParametersExpand Collapse

name: string

A human-readable name for the volume snapshot.

tags: optional array of string

A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.

Requires tag:create scope.

ReturnsExpand Collapse

snapshot: optional Snapshots { id, created_at, min_disk_size, 6 more }

id: string

The unique identifier for the snapshot.

created_at: string

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

formatdate-time

min_disk_size: number

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

name: string

A human-readable name for the snapshot.

regions: array of string

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

resource_id: string

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

resource_type: "droplet" or "volume"

The type of resource that the snapshot originated from.

Accepts one of the following:

"droplet"

"volume"

size_gigabytes: number

The billable size of the snapshot in gigabytes.

formatfloat

tags: array of string

An array of Tags the snapshot has been tagged with.

Requires tag:read scope.

Create Snapshot from a Volume

curl https://api.digitalocean.com/v2/volumes/$VOLUME_ID/snapshots \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN" \
    -d '{
          "name": "big-data-snapshot1475261774",
          "tags": [
            "base-image",
            "prod"
          ]
        }'

{
  "snapshot": {
    "id": "8fa70202-873f-11e6-8b68-000f533176b1",
    "created_at": "2020-09-30T18:56:14Z",
    "min_disk_size": 10,
    "name": "big-data-snapshot1475261774",
    "regions": [
      "nyc1"
    ],
    "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41",
    "resource_type": "volume",
    "size_gigabytes": 10,
    "tags": [
      "aninterestingtag"
    ]
  }
}

Returns Examples

{
  "snapshot": {
    "id": "8fa70202-873f-11e6-8b68-000f533176b1",
    "created_at": "2020-09-30T18:56:14Z",
    "min_disk_size": 10,
    "name": "big-data-snapshot1475261774",
    "regions": [
      "nyc1"
    ],
    "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41",
    "resource_type": "volume",
    "size_gigabytes": 10,
    "tags": [
      "aninterestingtag"
    ]
  }
}