This is the multi-page printable view of this section. Click here to print.
List snapshots
1 - 1.3
scp-cli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
[--sort <value>]
Description
List snapshots.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id optional | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| limit optional | integer | Page size of items | 20 |
| offset optional | integer | Index of where to start in the list | 0 |
| marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| with_count optional | boolean | Whether to show count | True |
| name optional | string | Snapshot name | snapshot-1 |
| sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of | created_at:desc |
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 |
2 - 1.2
scp-cli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
[--sort <value>]
Description
List snapshots.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id optional | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| limit optional | integer | Page size of items | 20 |
| offset optional | integer | Index of where to start in the list | 0 |
| marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| with_count optional | boolean | Whether to show count | True |
| name optional | string | Snapshot name | snapshot-1 |
| sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of | created_at:desc |
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 |
3 - 1.1
scp-cli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
Description
List snapshots.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id optional | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| limit optional | integer | Page size of items | 20 |
| offset optional | integer | Index of where to start in the list | 0 |
| marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| with_count optional | boolean | Whether to show count | True |
| name optional | string | Snapshot name | snapshot-1 |
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 |
4 - 1.0
scp-cli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
Description
List snapshots.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id optional | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| limit optional | integer | Page size of items | 20 |
| offset optional | integer | Index of where to start in the list | 0 |
| marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| with_count optional | boolean | Whether to show count | True |
| name optional | string | Snapshot name | snapshot-1 |
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 |