Apache CloudStack 4.23.0.0 Root Admin API Reference

finalizeBackup

Finalize a VM backup session. This API is intended for testing only and is disabled by default.

Request parameters

Parameter NameDescriptionRequired
idID of the backuptrue
virtualmachineidID of the VMtrue

Response Tags

Response NameDescription
idID of the Instance backup
accountAccount name
accountidAccount id
backupofferingidBackup offering id
backupofferingnameBackup offering name
compressionstatusBackup compression status.
createdBackup date
descriptiondescription for the backup
domainDomain name
domainidDomain ID
externalidExternal backup id
fromcheckpointidPrevious active checkpoint ID for incremental backups
hostidHost ID where the backup is running
intervaltypeInterval type of the backup
isbackupvmexpungedIndicates whether the VM from which the backup was taken is expunged or not
namename of the backup
sizeBackup size in bytes
statusBackup status
tocheckpointidNext checkpoint ID for incremental backups
typeBackup type
uncompressedsizeBackup uncompressed size in bytes. Only defined if backup is compressed.
validationstatusBackup validation status.
virtualmachineidID of the Instance
virtualmachinenameName of the Instance
virtualsizeBackup protected (virtual) size in bytes
vmbackupofferingremovedThe backup offering corresponding to this backup was removed from the VM
vmdetailsLists the vm specific details for the backup
volumesBacked up volumes
zoneZone name
zoneidZone ID