Resource Changes

In this article

    The following list contains changes to operations and schemas. Note that these changes do not affect REST API v3.0 functionality.

    Operation Changes

    • Removed the PatchResellerSiteVcdReplicationResource operation from the specification.
    • Changed the URL path of the GetBackupServerBackupCopyJobsLinkedJobObjectsByServer operation from /infrastructure/backupServers{backupServerUid}/jobs/backupCopyJobs/jobObjects to /infrastructure/backupServers/{backupServerUid}/jobs/backupCopyJobs/jobObjects.
    • Added the required attribute to the request body in the following operations:
    • UsernamePasswordAuthenticate
    • RefreshTokenAuthenticate
    • InstallSiteLicense
    • InstallBackupServerLicense
    • InstallConsoleLicense
    • You can now add embedded properties to resource representations returned by the following operations:
    • GetResellers
    • GetOrganizationIdentityProvidersRules
    • GetOrganizationsIdentityProvidersRules
    • GetIdentityProviderRules
    • GetCompaniesByReseller
    • GetProvider
    • GetProviderCompanies
    • GetCompanies
    • GetCompaniesBySubscriptionPlan
    • GetBackupServerBackupVmJobs
    • GetBackupServerBackupVmJobsByServer
    • GetBackupServerReplicationVmJobs
    • GetBackupServerReplicationVmJobsByServer
    • GetBackupServerBackupCopyJobs
    • GetBackupServerBackupCopyJobsByServer
    • GetBackupServerFileShareJobs
    • GetBackupServerFileShareJobsByServer
    • GetBackupServerFileShareCopyJobs
    • GetBackupServerFileShareCopyJobsByServer
    • GetBackupServerImmediateBackupCopyJobs
    • GetBackupServerImmediateBackupCopyJobsByServer
    • GetBackupServerVmCopyJobs
    • GetBackupServerVmCopyJobsByServer
    • GetBackupServerFileCopyJobs
    • GetBackupServerFileCopyJobsByServer
    • GetBackupServerFileTapeJobs
    • GetBackupServerFileTapeJobsByServer
    • GetBackupServerBackupTapeJobs
    • GetBackupServerBackupTapeJobsByServer
    • GetBackupServerAgentJobs
    • GetBackupServerAgentJobsByServer
    • GetWindowsDiscoveryRules
    • GetWindowsNetworkBasedDiscoveryRules
    • GetWindowsActiveDirectoryBasedDiscoveryRules
    • GetWindowsCustomDiscoveryRules
    • GetLinuxDiscoveryRules
    • GetLinuxNetworkBasedDiscoveryRules
    • GetLinuxCustomDiscoveryRules

    For details on embedded properties, see Expand Parameter.

    ID Changes

    • GetBackupServerImmediatelyBackupCopyJobs => GetBackupServerImmediateBackupCopyJobs
    • GetBackupServerImmediatelyBackupCopyJob => GetBackupServerImmediateBackupCopyJob
    • GetBackupServerImmediatelyBackupCopyJobsByServer => GetBackupServerImmediateBackupCopyJobsByServer
    • GetBackupServerImmediatelyBackupCopyJobsLinkedJobObjects => GetBackupServerImmediateBackupCopyJobsLinkedJobObjects
    • GetBackupServerImmediatelyBackupCopyJobLinkedJobObjects => GetBackupServerImmediateBackupCopyJobLinkedJobObjects
    • GetBackupServerImmediatelyBackupCopyJobsLinkedJobObjectsByServer => GetBackupServerImmediateBackupCopyJobsLinkedJobObjectsByServer
    • GetVcdOrganizations => GetVcdOrganizationsBySite
    • GetVcdOrganizationVDCs => GetVcdOrganizationVDCsBySite
    • GetVcdOrganizationUsers => GetVcdOrganizationUsersBySite

    Schema and Enum Changes

    • Added the readOnly attribute to the preFailoverScriptEnabled and postFailoverScriptEnabled propeties of the BackupFailoverPlan schema.
    • Applied multiple changes to the SmtpSettings schema:
    • Added the serverCertificate and exclusivelyAcceptedCertificateHash properties.
    • Merged serverAddress and port properties into the serverAddress property.
    • Replaced the UseSSL property with the TlsMode property.
    • Moved username and password properties to a separate subschema in the passwordCredantial property. The subschema also contains the saslMechanism property.
    • Renamed the customNotes property of the ManagementAgent schema to tag.
    • Renamed the connectionAcount property of the ManagementAgent schema to connectionAccount.
    • Added the nullable attribute to the lastRestorePointSize and totalRestorePointsSize properties of the ProtectedVirtualMachine and ProtectedVirtualMachineBackup schemas. Previously these properties had the 0 value if no data was present.
    • Added the nullable attribute to the usedSourceSize property of the ProtectedVirtualMachine, ProtectedComputerManagedByBackupServerBackup and ProtectedComputerManagedByBackupServerRestorePoint schemas. Previously the property had the -1 value if no data was present.
    • Added the nullable attribute to the sourceSize property of the ProtectedComputerManagedByConsoleJob schema. Previously the property had the -1 value if no data was present.
    • Added the nullable attribute to the lastSession property of the BackupServerVmJobObject schema.
    • Added the nullable attribute to the targetPath and targetHostUid properties of the BackupServerFileCopyJob schema.
    • Added the nullable attribute to the backupPolicyRevision property of the BackupAgentAssignedBackupPolicy schema. Previously the property had the -1 value if no data was present.
    • The ObjectEntity value of the AlarmObjectType enum is now deprecated and split into the following values:
    • BackupAgent
    • BackupMicrosoft365Server  
    • BackupProxy
    • BackupRepository
    • BackupServer
    • BackupServerJob
    • BackupWanAccelerator
    • CloudGateway
    • CloudRepository
    • EnterpriseManagerServer
    • FailoverPlan
    • VOneServer
    • Renamed the ImmediatelyBackupCopy value of the BackupServerJobType enum to ImmediateBackupCopy.
    • Added the AhvStorageSnapshotJob value to the BackupServerJobType enum.
    • Renamed the VBRNutanixVM value of the BackupServerLicenseCounterType enum to VBR_AHV_VM.
    • Added the VBR_RHV_VM value to the BackupServerLicenseCounterType enum.

    Schema and Enum Renaming

    • BackupServerImmediatelyBackupCopyJob => BackupServerImmediateBackupCopyJob
    • ProtectedComputerJob => ProtectedComputerManagedByConsoleJob
    • ProtectedComputerRestorePoint => ProtectedComputerManagedByConsoleRestorePoint
    • DeploymentConfiguraion => DeploymentConfiguration
    • LinuxDeploymentConfiguraion => LinuxDeploymentConfiguration
    • LicenseReportParemeters => LicenseReportParameters
    • BackupPolicyMode => BackupJobOperationMode