Apache CloudStack 4.23.0.0 Root Admin API Reference
startBackup
Start a VM backup session using pull mode backup-begin on the KVM host. This API is intended for testing only and is disabled by default.
Request parameters
| Parameter Name | Description | Required |
| virtualmachineid | ID of the VM | true |
| description | the description for the backup | false |
| name | the name of the backup | false |
Response Tags
| Response Name | Description |
| id | ID of the Instance backup |
| account | Account name |
| accountid | Account id |
| backupofferingid | Backup offering id |
| backupofferingname | Backup offering name |
| compressionstatus | Backup compression status. |
| created | Backup date |
| description | description for the backup |
| domain | Domain name |
| domainid | Domain ID |
| externalid | External backup id |
| fromcheckpointid | Previous active checkpoint ID for incremental backups |
| hostid | Host ID where the backup is running |
| intervaltype | Interval type of the backup |
| isbackupvmexpunged | Indicates whether the VM from which the backup was taken is expunged or not |
| name | name of the backup |
| size | Backup size in bytes |
| status | Backup status |
| tocheckpointid | Next checkpoint ID for incremental backups |
| type | Backup type |
| uncompressedsize | Backup uncompressed size in bytes. Only defined if backup is compressed. |
| validationstatus | Backup validation status. |
| virtualmachineid | ID of the Instance |
| virtualmachinename | Name of the Instance |
| virtualsize | Backup protected (virtual) size in bytes |
| vmbackupofferingremoved | The backup offering corresponding to this backup was removed from the VM |
| vmdetails | Lists the vm specific details for the backup |
| volumes | Backed up volumes |
| zone | Zone name |
| zoneid | Zone ID |