This is an archive version of the document. To get the most up-to-date information, see the current version.

Schema Changes

The following list contains changes applied to schemas in REST API v3.3.

Removed the readOnly attribute from the organizationUid property of the UserInput schema.
Removed the readOnly attribute from the userName property of the Credentials schema.
Added the nullable:true attribute to the smtp property of the NotificationSettings schema. The property is no longer marked as required.
Replaced the managementAgentVersion property of the About schema with the following properties:

Added the fullHealthCheck property to the WindowsMaintenanceJobSettings schema.
Added the fileShareUid and fileServerUid properties to the BackupServerFileShareJobObject schema.
Applied the following changes to the SubscriptionPlan schema:

Added the publicCloud and vb365 properties.
The managedCloudVmPrice property of the SubscriptionPlanManagedBackup subschema replaced with the cloudVmPrice of the SubscriptionPlanPublicCloud subschema.
The freeManagedCloudVms property of the SubscriptionPlanManagedBackup subschema replaced with the freecloudVms of the SubscriptionPlanPublicCloud subschema.
The maxLength attribute of the description property now has the 2048 value.

Added the monitoredServicePrice, managedCdpVmPrice and freeManagedCdpVms properties to the SubscriptionPlanManagedBackup schema.
Added the companyServices and loginUrl properties to the Company schema.
Added the companyServices property to the CompanyInput schema.
Replaced the hierarchyRegerence property of the BackupServerCdpReplicationJobObject with the parentHostRef and hierarchyRef. For older version clients, the you can use the following algorithm:

```csharp

string.IsNullOrEmpty(source.ParentHostRef) ? source.HierarchyRef : $"{source.ParentHostRef}_{source.HierarchyRef}"

```

Added the workloads property to the PulseLicense schema.
Added the siteUid property to the UserBackupResourceInput subschema of the UserInput schema.
Added the siteUid property to the UserBackupResource schema.
Added the isImmutabilityEnabled and immutabilityInterval properties to the BackupRepository schema.
Added the externalIpList property to the CloudGateway schema.
Applied the following changes to the Organization and OrganizationInput schemas:

Added the locationAdmin0Code, locationAdmin1Code, and locationAdmin2Code properties.
Changed the name of the companyId property to veeamTenantId.

Added the siteUid property to the CompanySiteReplicationResourceUsage schema.
Added the siteUid property to the CompanySiteVcdReplicationResourceUsage schema.
Added the following properties to the ResellerQuota subschema of the Reseller and ResellerInput schemas:

Renamed the vbm365ServerUid property of the Vb365ServerLicense (previously Vbm365ServerLicense) schema to vb365ServerUid.
Added the description and workloadsByPlatform properties to the WorkloadLicenseUsage schema.
Added the clonedCloudServers and unsupportedCloudServers properties to the SingleLicenseReport schema.
Added the unsupportedCloudServers property to the LicenseReportAppendix schema.
Added the unsupportedClientServers property to the OrganizationUsageOfLicensesWithSameSupportId schema.
Added the nullable:true attribute to the agentUid property of the BackupServerAgentJobObject schema.
Renamed the fileServerUid property of the BackupServerFileShareCopyJobObject and BackupServerFileShareJobObject schemas to fileShareUid.
Deleted the webUri property of the BrandingSettings schema.
Added the oAuth2Credential property to the SmtpSettings schema.
Increased the maxLength attribute value to 1024 for the description property of the following schemas:

The mfaPolicyStatus property of the UserInput schema now includes the values of the UserMfaPolicyyStatusInput enum instead of the UserMfaPolicyStatus enum.
Added the IsAutomaticReportingEnabled property to the PulseLicenseInput schema.
Applied the following changes to the NotificationAlarmsSettings schema:

Added the DailyStatusFilter and DailySorting properties.
Removed the nullable:true attribute from the dailySubject property. The older client versions will receive the following default value instead of null: Company: "%company%", Location: "%location%", Alarm: "%alarmName%", Status: "%alarmStatus%".

Removed the nullable:true attribute from the subject property of the NotificationDiscoverySettings schema. The older client versions will receive the following default value instead of null: Company: "%company%", Location: "%location%", Rule: "%ruleName%", Status: "%ruleStatus%".
Removed the instanceUid property from the UserInput schema.
Applied the following changes to the ProtectedCloudVirtualMachineBackup schema:

Increased the maximum value of the keepWeeklyBackupsForWeeks property of the WindowsGfsWeeklyRetentionSettings schema to 9999.
Added the GfsRetentionSettings property to the LinuxBackupJobConfiguration schema. If the entity is created with the older version of REST API Client, the property value is null.
Renamed the BackupServerImmediateBackupCopyJob schema to BackupServerSimpleBackupCopyJob.
Renamed the LastAlarmActivation schema to AlarmActivation.
Deleted the following schemas: