Give Feedback

dots.v2.volumes.byVolume_id().snapshots.post()

Generated on 27 Oct 2026 from DoTs version v1.21.0

Copy page as Markdown View page as Markdown

Usage

client.v2.volumes.byVolume_id(volume_id).snapshots.post(body: SnapshotsPostRequestBody, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | SnapshotsPostResponse>

Description

To create a snapshot from a volume, sent a POST request to /v2/volumes/{volume_id}/snapshots.

Parameters

Path Parameters

volume_id string required

Example: 7724db7c-e098-11e5-b522-000f53304e51

The ID of the block storage volume.

Request Body

name string required

Example: big-data-snapshot1475261774

A human-readable name for the volume snapshot.

tags array of strings or null optional

Example: ["base-image", "prod"]

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.

Request Sample

Show Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.volumes
    .byVolume_id("7724db7c-e098-11e5-b522-000f53304e51").snapshots.post({
    name: "big-data-snapshot1475261774",
});

Response Example

Show Response Example

{
  "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"
    ]
  }
}

More Information

See /v2/volumes/{volume_id}/snapshots in the API reference for additional detail on responses, headers, parameters, and more.