VM Snapshot

Point-in-time snapshots of a virtual machine's disk and (optionally) memory state.

Resource base path: /restapi/vmsnapshot

Method	Path	Description
POST	/restapi/vmsnapshot/createVmSnapshot	Create VM Snapshot
GET	/restapi/vmsnapshot/vmsnapshotList	VM Snapshot List
GET	/restapi/vmsnapshot/revertToVmSnapshot	Revert VM Snapshot
DELETE	/restapi/vmsnapshot/deleteVmSnapshot/{uuid}	Delete VM Snapshot

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Create VM Snapshot

Create VM Snapshot.

POST /restapi/vmsnapshot/createVmSnapshot

Request body

Field	Type	Required	Description
snapshotMemory	boolean	No
name	string	No	Name of the resource.
zoneUuid	string	No	UUID of the zone the resource belongs to.
virtualmachineUuid	string	No	UUID of the virtual-machine instance.
description	string	No	Human-readable description.

{
  "snapshotMemory": true,
  "name": "example-name",
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "virtualmachineUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "description": "string"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/vmsnapshot/createVmSnapshot" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "snapshotMemory": true,
  "name": "example-name",
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "virtualmachineUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "description": "string"
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listVmSnapshotResponse": [
    {
      "jobId": "string",
      "isCurrent": true,
      "domainName": "example-name",
      "name": "example-name",
      "createdTimeStamp": 1,
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

---

VM Snapshot List

VM Snapshot List.

GET /restapi/vmsnapshot/vmsnapshotList

Parameters

Parameter	In	Type	Required	Description
zoneUuid	query	string	✅ Yes	UUID of the zone the resource belongs to.
uuid	query	string	No	UUID of the resource.
jobId	query	string	No	Job ID returned by the asynchronous operation.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/vmsnapshot/vmsnapshotList?zoneUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listVmSnapshotResponse": [
    {
      "jobId": "string",
      "isCurrent": true,
      "domainName": "example-name",
      "name": "example-name",
      "createdTimeStamp": 1,
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

---

Revert VM Snapshot

Revert VM Snapshot.

GET /restapi/vmsnapshot/revertToVmSnapshot

Parameters

Parameter	In	Type	Required	Description
uuid	query	string	✅ Yes	UUID of the resource.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/vmsnapshot/revertToVmSnapshot?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listVmSnapshotResponse": [
    {
      "jobId": "string",
      "isCurrent": true,
      "domainName": "example-name",
      "name": "example-name",
      "createdTimeStamp": 1,
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

---

Delete VM Snapshot

Delete VM Snapshot.

DELETE /restapi/vmsnapshot/deleteVmSnapshot/{uuid}

Parameters

Parameter	In	Type	Required	Description
uuid	path	string	✅ Yes	UUID of the resource.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/vmsnapshot/deleteVmSnapshot/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "Active"
}