Get Vm Snapshots

Get Vm Snapshots

Get a paged list of all snapshots of a VM

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/vm/{vmUrn}/snapshots
COPY
Path Parameters
string
vmUrn
Required

vmUrn

Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VmSnapshots of type(s) application/json;version=40.0
This response body class contains all of the following: InlineVmSnapshots0 , InlineVmSnapshots1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "name": "Snapshot Sample Name",
            "isCurrent": false,
            "state": "string",
            "storageConsumedMb": 0,
            "dateCreated": "string",
            "memory": false,
            "quiesce": false,
            "vappSnapshotId": "string",
            "parentSnapshotId": "string",
            "vm": {
                "name": "string",
                "id": "string"
            },
            "type": "string"
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/vm/{vmUrn}/snapshots?page=value&pageSize=v
Availability
Added in 39.0
On This Page
Vm Snapshots Operations
GET
Get Vm Snapshots
POST
Create Vm Snapshot
GET
Get Vm Snapshot
PUT
Update Vm Snapshot
DELETE
Remove Vm Snapshot