Backup VM

Running this function will make an image out of your virtual machine that you can use to restore or build a new VM.

VM Backups

Backups (or snapshots) of your virtual machine become images that you can use to duplicate your efforts in different regions. If you quickly need to scale an application, you can take a live snapshot, and immediately create a duplicate with all of your data.

Backup VM URL:

POSThttps://api.hyperleaf.com/api/vms/backup

Request Fields (* required)

Name	Type	Description
uuid*	string	UUID of the virtual machine
backup_name*	string	name of the backup
pause	yes / no	pause the virtual machine while doing backup

Pause Field

If you set pause to yes, the system will pause the virtual machine and do a backup of the image. If you set pause to no, or leave blank, the virtual machine will need to be shutdown first, or this function will return a failure.

The virtual machine will be paused for about 1/2 second per GB. If the VM is 20gb, it should be paused for 10-20 seconds before resuming where it left off.

A 120gb VM will be around 1 minute.

Post Example

CURL POST

curl https://api.hyperleaf.com/api/vms/backup?key=mykey \
    -d 'uuid=32h9-2hf92h'2d23fh92h' \
    -d 'backup_name=my+personal+machine'

Response Examples

Success

{"status":"ok","image_uuid":"j92-dh2f-jwdj9d2"}

Failure