Breaking Changes
Breaking changes cause REST API to function differently and can affect the client code.
New Required Properties
The ManagedServerModel object now has the status property, which shows an availability status of the server.
Paths Renaming
In REST API 1.1-rev1, the following paths are renamed.
Section | Old Path | New Path |
|---|---|---|
Backups | /api/v1/objectRestorePoints | /api/v1/restorePoints |
/api/v1/objectRestorePoints/{id} | /api/v1/restorePoints/{id} | |
/api/v1/objectRestorePoints/{id}/disks | /api/v1/restorePoints/{id}/disks | |
Restore | /api/v1/restore/vmRestore/vmware | /api/v1/restore/vmRestore/vSphere |
/api/v1/restore/instantRecovery/vmware | /api/v1/restore/vmRestore/vSphere | |
/api/v1/restore/instantRecovery/vmware | /api/v1/restore/instantRecovery/vSphere/vm | |
/api/v1/restore/instantRecovery/vmware/vm/{mountId} | /api/v1/restore/instantRecovery/vSphere/vm/{mountId} | |
/api/v1/restore/instantRecovery/vmware/vm/{mountId}/unmount | /api/v1/restore/instantRecovery/vSphere/vm/{mountId}/unmount | |
/api/v1/restore/instantRecovery/vmware/vm/{mountId}/migrate | /api/v1/restore/instantRecovery/vSpheres/vm/{mountId}/migrate | |
/api/v1/restore/instantRecovery/vmware/fcd | /api/v1/restore/instantRecovery/vSphere/fcd | |
/api/v1/restore/instantRecovery/vmware/fcd/{mountId} | /api/v1/restore/instantRecovery/vSphere/fcd/{mountId} | |
/api/v1/restore/instantRecovery/vmware/fcd/{mountId}/dismount | /api/v1/restore/instantRecovery/vSphere/fcd/{mountId}/unmount | |
/api/v1/restore/instantRecovery/vmware/fcd/{mountId}/migrate | /api/v1/restore/instantRecovery/vSphere/fcd/{mountId}/migrate |
Properties Renaming
In REST API 1.1-rev1, the following properties are renamed:
Section | Old Name | New Name |
|---|---|---|
Credentials | StandardCredentialsModel.tag | StandardCredentialsModel.uniqueId |
LinuxCredentialsModel.tag | LinuxCredentialsModel.uniqueId | |
LinuxCredentialsModel.autoElevated | LinuxCredentialsModel.elevateToRoot | |
StandardCredentialsSpec.tag | StandardCredentialsSpec.uniqueId | |
LinuxCredentialsSpec.tag | LinuxCredentialsSpec.uniqueId | |
LinuxCredentialsSpec.autoElevated | LinuxCredentialsSpec.elevateToRoot | |
Cloud Credentials | AmazonCloudCredentialsModel.tag | AmazonCloudCredentialsModel.uniqueId |
AzureStorageCloudCredentialsModel.tag | AzureStorageCloudCredentialsModel.uniqueId | |
AzureComputeCloudCredentialsModel.tag | AzureComputeCloudCredentialsModel.uniqueId | |
GoogleCloudCredentialsModel.tag | GoogleCloudCredentialsModel.uniqueId | |
GoogleCloudServiceCredentialsModel.tag | GoogleCloudServiceCredentialsModel.uniqueId | |
AmazonCloudCredentialsSpec.tag | AmazonCloudCredentialsSpec.uniqueId | |
AzureStorageCloudCredentialsSpec.tag | AzureStorageCloudCredentialsSpec.uniqueId | |
AzureComputeCloudCredentialsSpec.tag | AzureComputeCloudCredentialsSpec.uniqueId | |
GoogleCloudCredentialsSpec.tag | GoogleCloudCredentialsSpec.uniqueId | |
Encrypted Passwords | EncryptionPasswordSpec.tag | EncryptionPasswordSpec.uniqueId |
EncryptionPasswordModel.tag | EncryptionPasswordModel.uniqueId | |
Managed Servers | WindowsHostPortsModel.serverThisSide | WindowsHostPortsModel.serverSide |
LinuxHostSSHSettingsModel.sshTimeOutMs | LinuxHostSSHSettingsModel.sshTimeOutMs | |
LinuxHostSSHSettingsModel.serverThisSide | LinuxHostSSHSettingsModel.serverSide | |
Proxies | ProxyDatastoreSettingsModel.autoSelect | ProxyDatastoreSettingsModel.autoSelectEnabled |
Repositories | RepositorySpec.tag | RepositorySpec.uniqueId |
WindowsLocalRepositorySettingsModel.enableTaskLimit | WindowsLocalRepositorySettingsModel.taskLimitEnabled | |
WindowsLocalRepositorySettingsModel.enableReadWriteLimit | WindowsLocalRepositorySettingsModel.readWriteLimitEnabled | |
LinuxLocalRepositorySettingsModel.enableTaskLimit | LinuxLocalRepositorySettingsModel.taskLimitEnabled | |
LinuxLocalRepositorySettingsModel.enableReadWriteLimit | LinuxLocalRepositorySettingsModel.readWriteLimitEnabled | |
NetworkRepositorySettingsModel.enableTaskLimit | NetworkRepositorySettingsModel.taskLimitEnabled | |
NetworkRepositorySettingsModel.enableReadWriteLimit | NetworkRepositorySettingsModel.readWriteLimitEnabled | |
AzureBlobStorageSpec.enableTaskLimit | AzureBlobStorageSpec.taskLimitEnabled | |
AzureDataBoxStorageSpec.enableTaskLimit | AzureDataBoxStorageSpec.taskLimitEnabled | |
AmazonS3StorageSpec.enableTaskLimit | AmazonS3StorageSpec.taskLimitEnabled | |
AmazonSnowballEdgeStorageSpec.enableTaskLimit | AmazonSnowballEdgeStorageSpec.taskLimitEnabled | |
S3CompatibleStorageSpec.enableTaskLimit | S3CompatibleStorageSpec.taskLimitEnabled | |
GoogleCloudStorageSpec.enableTaskLimit | GoogleCloudStorageSpec.taskLimitEnabled | |
IBMCloudStorageSpec.enableTaskLimit | IBMCloudStorageSpec.taskLimitEnabled | |
WasabiCloudStorageSpec.enableTaskLimit | WasabiCloudStorageSpec.taskLimitEnabled | |
LinuxHardenedRepositorySettingsModel.enableTaskLimit | LinuxHardenedRepositorySettingsModel.taskLimitEnabled | |
LinuxHardenedRepositorySettingsModel.enableReadWriteLimit | LinuxHardenedRepositorySettingsModel.readWriteLimitEnabled | |
RepositoryShareGatewayModel.autoSelect | RepositoryShareGatewayModel.autoSelectEnabled | |
RepositoryModel.tag | RepositoryModel.uniqueId | |
AzureBlobStorageModel.enableTaskLimit | AzureBlobStorageModel.taskLimitEnabled | |
AmazonDataBoxStorageModel.enableTaskLimit | AmazonDataBoxStorageModel.taskLimitEnabled | |
AmazonS3StorageModel.enableTaskLimit | AmazonS3StorageModel.taskLimitEnabled | |
AmazonSnowballEdgeStorageModel.enableTaskLimit | AmazonSnowballEdgeStorageModel.taskLimitEnabled | |
S3CompatibleStorageModel.enableTaskLimit | S3CompatibleStorageModel.taskLimitEnabled | |
GoogleCloudStorageModel.enableTaskLimit | GoogleCloudStorageModel.taskLimitEnabled | |
IBMCloudStorageModel.enableTaskLimit | IBMCloudStorageModel.taskLimitEnabled | |
WasabiCloudStorageModel.enableTaskLimit | WasabiCloudStorageModel.taskLimitEnabled | |
ScaleOutRepositorySpec.tag | ScaleOutRepositorySpec.uniqueId | |
CapacityTierModel.enabled | CapacityTierModel.isEnabled | |
ScaleOutRepositoryModel.tag | ScaleOutRepositoryModel.uniqueId | |
Jobs | PrimaryStorageIntegrationSettingsModel.limitProcessedVm | PrimaryStorageIntegrationSettingsModel.processedVmsLimitEnabled |
PrimaryStorageIntegrationSettingsModel.limitProcessedVmCount | PrimaryStorageIntegrationSettingsModel.processedVmsCount | |
NotificationVmAttributeSettingsModel.appendToExisitingValue | NotificationVmAttributeSettingsModel.appendToExistingValue | |
BackupStorageSettingModel.enableInlineDataDedup | BackupStorageSettingModel.inlineDataDedupEnabled | |
BackupStorageSettingsEncryptionModel.encryptionPasswordTag | BackupStorageSettingsEncryptionModel.encryptionPasswordUniqueId | |
BackupProxiesSettingsModel.autoSelection | BackupProxiesSettingsModel.autoSelectEnabled | |
BackupLogShipingServerModel.autoSelection | BackupLogShipingServerModel.autoSelectEnabled | |
GuestInteractionProxiesSettingsModel.autoSelection | GuestInteractionProxiesSettingsModel.autoSelectEnabled | |
GuestOsCredentialsModel.credsId | GuestOsCredentialsModel.credentialsId | |
GuestOsCredentialsModel.credsType | GuestOsCredentialsModel.credentialsType | |
Backups | BackupModel.policyTag | BackupModel.policyUniqueId |
Restore | InstantViVMCustomizedRecoveryDatastoreSpec.redirectIsEnabled | InstantViVMCustomizedRecoveryDatastoreSpec.redirectEnabled |
SecureRestoreSpec.enableAntivirusScan | SecureRestoreSpec.antivirusScanEnabled | |
SecureRestoreSpec.enableEntireVolumeScan | SecureRestoreSpec.entireVolumeScanEnabled | |
RestoreProxySpec.autoSelection | RestoreProxySpec.autoSelectEnabled | |
VmwareFcdInstantRecoverySpec.objectRestorePointId | VmwareFcdInstantRecoverySpec.restorePointId | |
EntireViVMRestoreSpec.objectRestorePointId | EntireViVMRestoreSpec.restorePointId | |
InstantViVMRecoverySpec.objectRestorePointId | InstantViVMRecoverySpec.restorePointId | |
Sessions | SessionModel.activityId | SessionModel.jobId |
Automation | BackupLogShippingServersImportModel.autoSelection | BackupLogShippingServersImportModel.autoSelectEnabled |
BackupRepositoryImportModel.tag | BackupRepositoryImportModel.uniqueId | |
BackupProxyImportModel.tag | BackupProxyImportModel.uniqueId | |
RepositoryShareGatewayImportSpec.autoSelect | RepositoryShareGatewayImportSpec.autoSelectEnabled | |
CredentialsImportSpec.tag | CredentialsImportSpec.uniqueId | |
CredentialsLinuxSettingsImportModel.autoElevated | CredentialsLinuxSettingsImportModel.elevateToRoot | |
AzureStorageCloudCredentialsImportSpec.tag | AzureStorageCloudCredentialsImportSpec.uniqueId | |
AzureComputeCloudCredentialsImportSpec.tag | AzureComputeCloudCredentialsImportSpec.uniqueId | |
AmazonCloudCredentialsImportSpec.tag | AmazonCloudCredentialsImportSpec.uniqueId | |
GoogleCloudCredentialsImportSpec.tag | GoogleCloudCredentialsImportSpec.uniqueId | |
ProxyServerSettingsImportSpec.hostTag | ProxyServerSettingsImportSpec.hostUniqueId | |
WindowsLocalStorageImportSpec.tag | WindowsLocalStorageImportSpec.uniqueId | |
LinuxLocalStorageImportSpec.tag | LinuxLocalStorageImportSpec.uniqueId | |
SmbStorageImportSpec.tag | SmbStorageImportSpec.uniqueId | |
NfsStorageImportSpec.tag | NfsStorageImportSpec.uniqueId | |
AzureBlobStorageImportSpec.tag | AzureBlobStorageImportSpec.uniqueId | |
AzureDataBoxStorageImportSpec.tag | AzureDataBoxStorageImportSpec.uniqueId | |
AmazonS3StorageImportSpec.tag | AmazonS3StorageImportSpec.uniqueId | |
AmazonSnowballEdgeStorageImportSpec.tag | AmazonSnowballEdgeStorageImportSpec.uniqueId | |
S3CompatibleStorageImportSpec.tag | S3CompatibleStorageImportSpec.uniqueId | |
GoogleCloudStorageImportSpec.tag | GoogleCloudStorageImportSpec.uniqueId | |
IBMCloudStorageImportSpec.tag | IBMCloudStorageImportSpec.uniqueId | |
AmazonS3GlacierStorageImportSpec.tag | AmazonS3GlacierStorageImportSpec.uniqueId | |
AzureArchiveStorageImportSpec.tag | AzureArchiveStorageImportSpec.uniqueId | |
WasabiCloudStorageImportSpec.tag | WasabiCloudStorageImportSpec.uniqueId | |
LinuxHardenedStorageImportSpec.tag | LinuxHardenedStorageImportSpec.uniqueId | |
EncryptionPasswordImportSpec.tag | EncryptionPasswordImportSpec.uniqueId |
Property Values Renaming
The Backup value of the ESessionType enum is renamed to BackupJob.