1.2
1.2
scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]
Description
Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| name required | string | Snapshot name | snapshot-1 |
| description optional | string | Description | description |
| force optional | boolean | Whether to create a snapshot even if the volume is attached | True |
| metadata optional | object | One or more metadata key and value pairs for the snapshot | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| description | Description | description |
| metadata | One or more metadata key and value pairs for the snapshot | Metadata |
| name | Snapshot name | snapshot-1 |
| size | Volume size | 104 |
| status | Volume state | available |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |