v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB

DigitalOcean-public.v2-new_Block Storage

Create Snapshot from a Volume

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

post/v2/volumes/{volume_id}/snapshots

Path parameters

volume_idstring uuid required

The ID of the block storage volume.

Request body

namestring required

A human-readable name for the volume snapshot.

tagsstring[] nullable

A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. <br><br>Requires tag:create scope.

Example request

{
  "name": "big-data-snapshot1475261774",
  "tags": [
    "base-image",
    "prod"
  ]
}

Response

You will get back a JSON object that has a snapshot key. This will contain the standard snapshot attributes

Example response

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