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

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VmSnapshots of type(s) application/json;version=39.0
This response body class contains all of the following: Page , 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"
        }
    ]
}