This section describes REST API features implemented in Veeam Service Provider Console 9.

The following list includes changes that affect how Veeam Service Provider Console REST API works:

• Companies and Veeam Cloud Connect tenants are now treated as separate entities. Multiple changes were applied to related resources.

• REST API versions 3.1, 3.2 and 3.3 are no longer supported.

• Discontinued InfluxDB 1.x support for integration with Grafana. The Reporter and InfluxDbReporting properties were removed from the appsettings.json file. The dashboard configuration compatible with InfluxDB 1.x can no longer be downloaded.

• The data property of the response schema is now required. Response format is not affected.

The following list contains changes that cause previous versions of Veeam Service Provider Console REST API to function differently:

• For REST API v3.5 and v3.5.1, in the CompanyServices schema, the maximum value of the storageQuota property is now 2305843008139952128.

  Affected operations:

  • GetCompaniesByReseller
  • GetProviderCompanies
  • GetCompanies
  • CreateCompany
  • GetCompany
  • PatchCompany
  • GetCompaniesBySubscriptionPlan

• For REST API v3.5 and v3.5.1, in the CompanyHostedVbrBackupResource, CompanyVb365BackupResource and CompanyVb365BackupResourceInput schemas, the storageQuota property now represents the storage space quota in gigabytes instead of bytes. The minimum value is now 1 and the maximum value is now 104856551424.

  Affected operations:

  • GetCompaniesHostedVbrBackupResources
  • GetCompanyHostedVbrBackupResources
  • CreateCompanyHostedVbrBackupResource
  • GetCompanyHostedVbrBackupResource
  • PatchCompanyHostedVbrBackupResource
  • GetCompaniesVb365BackupResources
  • GetCompanyVb365BackupResources
  • CreateCompanyVb365BackupResource
  • GetCompanyVb365BackupResource
  • PatchCompanyVb365BackupResource

• For REST API v3.5 and v3.5.1, in the CompanySiteTrafficResource schema, the dataTransferOutQuota property now represents the data transfer out traffic quota in gigabytes instead of bytes. Note that to modify this property value using the PatchCompanySiteTrafficResource operation, you must still provide a new value in bytes.

  Affected operations:

  • GetCompanySiteTrafficResource
  • PatchCompanySiteTrafficResource

• The minimum value of the storageQuota property of the ResellerSiteBackupResource and ResellerSiteBackupResourceInput schemas is now 1073741824.

  Affected operations:

  • GetResellersSiteBackupResources
  • GetResellerSiteBackupResources
  • CreateResellerSiteBackupResource
  • GetResellerSiteBackupResource
  • PatchResellerSiteBackupResource

• Job schedulling can no longer be disabled for Veeam Backup & Replication and Veeam Backup for Microsoft 365 servers. The isJobSchedulingEnabled property was removed from the CompanyHostedVbrResource, and CompanyVb365Resource schemas. In previous versions, changes applied to the value of this property will be applied to a company that owns the server. Note that the isJobSchedulingEnabled property of the Vb365OrganizationBase schema defines whether the current user can apply changes.

  Affected operations:

  • GetCompaniesHostedVbrResource
  • GetCompanyHostedVbrResources
  • CreateCompanyHostedVbrResource
  • GetCompanyHostedVbrResource
  • PatchCompanyHostedVbrResource
  • GetCompaniesVb365Resources
  • GetCompanyVb365Resources
  • CreateCompanyVb365Resource
  • GetCompanyVb365Resource
  • PatchCompanyVb365Resource

Since companies are separated from Veeam Cloud Connect tenants in Veeam Service Provider Console v9, some operations related to companies and company site resources were changed or replaced. However, for older REST API versions, no behavior changes are present unless multiple tenants are assigned to a single company. The following list contains such operations and details on applied changes.

• The DeleteCompany operation now unassigns all assigned tenants and deletes a company. The removeBackups parameter was removed from the operation. In older REST API versions, the operation deletes both a company and all assigned tenants.

• Removed the GetCompaniesSiteResources operation. To get data on company site resources, use the GetTenants operation. In older REST API versions, the GetCompaniesSiteResources operation returns all tenants assigned to companies.

• Removed the GetCompanySiteResource operation. To get company site resource data, use the GetTenant operation. In older REST API versions, the GetCompanySiteResource operation returns a random tenant assigned to a company.

• Removed the CreateCompanySiteResource operation. To allocate a cloud resource to a company, create a tenant using the CreateTenant operation. In older REST API versions, the CreateCompanySiteResource operation creates a cloud resource on a site. If a company already has site resources assigned, the NotAllowedOperation error with the 1000 code is returned.

• The GetCompanySiteResources operation now returns the collection of resources with CloudTenant schema instead of the CompanySiteResource schema.

• Removed the DeleteCompanySiteResource operation. To remove company cloud resource, delete a tenant assigned to a company using the DeleteTenant operation. The deleteBackups parameter of the DeleteTenant operation allows you to delete or retain cloud backups similar to the removeBackups parameter of the DeleteCompanySiteResource operation. In older REST API versions, the DeleteCompanySiteResource operation deletes a cloud resource on a site. If a company has more than one site resource assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the PatchCompanySiteResource operation with the PatchTenant operation. In older REST API version, the PatchCompanySiteResource operation modifies a cloud resource on a site. If a company has more than one site resource assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompaniesSiteBackupResources operation with the GetTenantsBackupResources operation. In older REST API versions, the GetCompaniesSiteBackupResources operation returns backup resources of all company tenants.

• Replaced the GetCompanySiteBackupResources operation with the GetTenantBackupResources operation. In older REST API versions, the GetCompanySiteBackupResources operation returns backup resources of all tenants assigned to a company.

• Replaced the CreateCompanySiteBackupResource operation with the CreateTenantBackupResource operation. In older REST API versions, the CreateCompanySiteBackupResource operation creates a site backup resource for a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompanySiteBackupResourcesUsage operation with the GetTenantBackupResourcesUsage operation. In older REST API versions, the GetCompanySiteBackupResourcesUsage operation returns data on usage of site backup resources for a company tenant registered as first in the database on a site.

• Replaced the GetCompaniesSiteBackupResourcesUsages operation with the GetTenantsBackupResourcesUsages operation. In older REST API versions, the GetCompaniesSiteBackupResourcesUsages operation returns data on usage of site backup resources for all tenants assigned to companies.

• Replaced the GetCompanySiteBackupResource operation with the GetTenantBackupResource operation. In older REST API versions, the GetCompanySiteBackupResource operation returns a site backup resource of a company tenant registered as first in the database on a site.

• Replaced the PatchCompanySiteBackupResource operation with the PatchTenantBackupResource operation. In older REST API versions, the PatchCompanySiteBackupResource operation modifies a site backup resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the DeleteCompanySiteBackupResource operation with the DeleteTenantBackupResource operation. In older REST API versions, the DeleteCompanySiteBackupResource operation deletes a site backup resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompanySiteTrafficResource operation with the GetTenantTrafficResource operation. In older REST API versions, the GetCompanySiteTrafficResource operation returns a cloud traffic quota configured for a company tenant registered as first in the database on a site.

• Replaced the PatchCompanySiteTrafficResource operation with the PatchTenantTrafficResource operation. In older REST API versions, the PatchCompanySiteTrafficResource operation modifies a cloud traffic quota configured for a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompaniesSiteReplicationResources operation with the GetTenantsReplicationResources operation. In older REST API versions, the GetCompaniesSiteReplicationResources operation returns replication resources of all company tenants.

• Replaced the GetCompanySiteReplicationResources operation with the GetTenantReplicationResources operation. In older REST API versions, the GetCompanySiteReplicationResources operation returns replication resources of all tenants assigned to a company.

• Replaced the CreateCompanySiteReplicationResource operation with the CreateTenantReplicationResource operation. In older REST API versions, the CreateCompanySiteReplicationResource operation creates a site replication resource for a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the PatchCompanySiteReplicationResource operation with the PatchTenantReplicationResource operation. In older REST API versions, the PatchCompanySiteReplicationResource operation modifies a site replication resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompanySiteReplicationResourceHardwarePlan operation with the GetTenantReplicationResourceHardwarePlan operation. In older REST API versions, the GetCompanySiteReplicationResourceHardwarePlan operation returns a hardware plan of a company tenant registered as first in the database on a site.

• Removed the DeleteCompanySiteReplicationResourceHardwarePlan operation. To unassign a hardware plan from a company tenant, use the PatchTenantReplicationResource operation. In older REST API versions, the DeleteCompanySiteReplicationResourceHardwarePlan operation deletes a site replication resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompanySiteReplicationResourcesNetworkAppliances operation with the GetTenantReplicationResourcesNetworkAppliances operation. In older REST API versions, the GetCompanySiteReplicationResourcesNetworkAppliances operation returns all network extension appliances configured for a company tenant registered as first in the database on a site.

• Replaced the GetCompanySiteReplicationResourcesNetworkAppliance operation with the GetTenantReplicationResourcesNetworkAppliance operation. In older REST API versions, the GetCompanySiteReplicationResourcesNetworkAppliance operation returns a network extension appliance configured for a company tenant registered as first in the database on a site.

• Replaced the PatchCompanySiteReplicationResourcesNetworkAppliance operation with the PatchTenantReplicationResourcesNetworkAppliance operation. In older REST API versions, the PatchCompanySiteReplicationResourcesNetworkAppliance operation modifies a network extension appliance of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompaniesSiteReplicationResourcesUsages operation by the GetTenantsReplicationResourcesUsages operation. In older REST API versions, the GetCompaniesSiteReplicationResourcesUsages operation returns data on usage of site replication resources for all tenants assigned to companies.

• Replaced the GetCompanySiteReplicationResourcesUsage operation with the GetTenantReplicationResourcesUsage operation. In older REST API versions, the GetCompanySiteReplicationResourcesUsage operation returns data on usage of site replication resources for a company tenant registered as first in the database on a site.

• Replaced the GetCompaniesSiteVcdReplicationResources operation with the GetTenantsVcdReplicationResources operation. In older REST API versions, the GetCompaniesSiteVcdReplicationResources operation returns VMware Cloud Director replication resources of all company tenants.

• Replaced the GetCompanySiteVcdReplicationResources operation with the GetTenantVcdReplicationResources operation. In older REST API versions, the GetCompanySiteVcdReplicationResources operation returns VMware Cloud Director replication resources of all company tenants.

• Replaced the CreateCompanySiteVcdReplicationResource operation with the CreateTenantVcdReplicationResource operation. In older REST API versions, the CreateCompanySiteVcdReplicationResource operation creates a VMware Cloud Director replication resource for a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the PatchCompanySiteVcdReplicationResource operation with the PatchTenantVcdReplicationResource operation. In older REST API versions, the PatchCompanySiteVcdReplicationResource operation modifies a VMware Cloud Director replication resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompanySiteVcdReplicationResourceDataCenter operation with the GetTenantVcdReplicationResourceDataCenter operation. In older REST API versions, the GetCompanySiteVcdReplicationResourceDataCenter operation returns an organization VDC of a company tenant registered as first in the database on a site.

• Removed the DeleteCompanySiteVcdReplicationResourceDataCenter operation. Use the operation PatchTenantVcdReplicationResource to unassign an organization VDC from a company tenant. In older REST API versions, the DeleteCompanySiteVcdReplicationResourceDataCenter operation unassigns an organization VDC from a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

• Replaced the GetCompaniesSiteVcdReplicationResourcesUsages operation with the GetTenantsVcdReplicationResourcesUsages operation. In older REST API versions, the GetCompaniesSiteVcdReplicationResourcesUsages operation returns data on usage of VMware Cloud Director replication resources for all tenants assigned to companies.

• Replaced the GetCompanySiteVcdReplicationResourcesUsage operation with the GetTenantVcdReplicationResourcesUsage operation. In older REST API versions, the GetCompanySiteVcdReplicationResourcesUsage operation returns data on usage of VMware Cloud Director replication resources for a company tenant registered as first in the database on a site.

• Replaced the GetCompanySiteVcdReplicationResourcesNetworkAppliances operation with the GetTenantVcdReplicationResourcesNetworkAppliances operation. In older REST API versions, the GetCompanySiteVcdReplicationResourcesNetworkAppliances operation returns all VMware Cloud Director network extension appliances configured for a company tenant registered as first in the database on a site.

• Replaced the GetCompanySiteVcdReplicationResourcesNetworkAppliance operation with the GetTenantVcdReplicationResourcesNetworkAppliance operation. In older REST API versions, the GetCompanySiteVcdReplicationResourcesNetworkAppliance operation returns a VMware Cloud Director network extension appliance configured for a company tenant registered as first in the database on a site.

• Replaced the PatchCompanySiteVcdReplicationResourcesNetworkAppliance operation with the new PatchTenantVcdReplicationResourcesNetworkAppliance operation. In older REST API versions, the PatchCompanySiteVcdReplicationResourcesNetworkAppliance operation modifies a VMware Cloud Director network extension appliance of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

This section contains changes to operations and schemas. Note that these changes do not affect functionality of the previous REST API versions.

The following list contains changes applied to operations in REST API v3.6.

• Renamed the date-time parameter of the StartBackupFailoverPlan operation into dateTime.

• Added the expand parameter to the GetVb365Microsoft365Organization operation.

• Replaced the IdentityProviderSettings request body schema of the CreateSaml2IdentityProvider operation with the IdentityProviderSettingsInput schema.

• In the SetSiteMaintenanceMode operation, the request body boolean parameter defining if the maintenance mode is enabled is now the maintenanceMode query parameter.

• In the SetSiteTenantManagementMode operation, the request body boolean parameter defining if the tenant management mode is enabled is now the tenantManagementMode query parameter.

• Replaced the /organizations/companies/{companyUid}/sites operation URL path with /organizations/companies/{companyUid}/siteResources.

• Removed the following operations:

  • GetResellerPermissions. The information on whether a reseller can access REST API is returned by the GetReseller operation in the isRestAccessEnabled property.
  • PatchResellerPermissions. To change reseller access to REST API, modify the isRestAccessEnabled property value with the PatchReseller operation.
  • GetCompanyPermissions. The information on whether a company can access REST API is returned by the GetCompany operation in the isRestAccessEnabled property.
  • PatchCompanyPermissions. To change company access to REST API, modify the isRestAccessEnabled property value with the PatchCompany operation.

• The following operations are fully functional and are no longer present under the Preview Operations tag:

  • CreateBackupServerBackupVmVSphereJob
  • CreateBackupServerBackupVmVcdJob
  • DeleteBackupServerJob
  • ExpandBackupServerCloudDirectorObjectContainers
  • ExpandBackupServerVirtualServerObjectContainers
  • GetBackupServerBackupVmVSphereJobConfiguration
  • GetBackupServerBackupVmVcdJobConfiguration
  • GetBackupServerVirtualServerTagVirtualMachines
  • GetBackupServerVirtualServerTags
  • PatchBackupServerBackupVmVSphereJobConfiguration
  • PatchBackupServerBackupVmVcdJobConfiguration

• Removed the following deprecated operations:

  • AsymmetricAlgorithmChallenge
  • AsymmetricAlgorithmCompleteChallenge
  • UsernamePasswordAuthenticate
  • RefreshTokenAuthenticate

This section contains changes applied to schemas in REST API v3.6.

Company and CompanyInput

Applied the following changes:

• Added the remoteServices property containing the CompanyRemoteServices schema.
• Added the hostedServices property containing the CompanyHostedServices schema.
• Replaced the permissions property with the isRestAccessEnabled property.

Reseller and ResellerInput

Applied the following changes:

• Replaced the permissions property with the isRestAccessEnabled property.
• The quota property was replaced with the resellerServices property.

ResellerQuota

The properties of the ResellerQuota schema were included in the other schemas with the following changes applied:

• Replaced the serversQuota property with the serverAgentsQuota property of the ResellerBackupAgentsManagement schema.

• Instead of the isServersQuotaUnlimited property, unlimited company server quota is determined by the serverAgentsQuota property of the ResellerBackupAgentsManagement schema. If the value of the property is null, maximum number of managed company servers is unlimited.

• Replaced the workstationsQuota property with the workstationAgentsQuota property of the ResellerBackupAgentsManagement schema.

• Instead of the isWorkstationsQuotaUnlimited property, unlimited company workstation quota is determined by the workstationAgentsQuota property of the ResellerBackupAgentsManagement schema. If the value of the property is null, maximum number of managed company workstations is unlimited.

• Moved the isFileLevelRestoreEnabled property to the ResellerServices schema.

• Replaced the isVbPublicCloudManagementEnabled property with the vbPublicCloudManagementEnabled property of the ResellerHostedServices and ResellerRemoteServices schemas. If property value is changed using the older REST API version, changes are applied in both schemas.

• Moved the following properties to the ResellerCloudConnectQuota schema:

  • dataTransferOutQuota
  • insiderProtectionQuota
  • throttlingValue
  • throttlingUnit
  • maxConcurrentTask
  • isWanAccelerationEnabled

• Removed the following properties:

  • isDataTransferOutQuotaUnlimited. To configure unlimited data transfer out quota, provide the null value in the dataTransferOutQuota property.
  • isThrottlingEnabled. To configure unlimited amount of incoming network traffic, provide the null value in the throttlingValue property.
  • isBandwidthUnlimited. To configure unlimited number of concurrent tasks, provide the null value in the maxConcurrentTask property.

If you perform modification of a reseller resource using an older REST API version, default values are applied to the empty cloudConnectQuota properties:

• dataTransferOutQuota: null
• insiderProtectionQuota: null
• throttlingUnit: null
• throttlingValue: null
• maxConcurrentTask: null
• isWanAccelerationEnabled: false

CompanyServices

Removed the schema. Properties included in the schema were replaced with properties in other schemas:

• Instead of the isBackupAgentManagementEnabled property, availability of Veeam Agent Management to company users is determined by the backupAgentsManagement property of the CompanyRemoteServices schema. If the value of the property is null, Veeam Agent Management is not available.

• Replaced the backupAgentServerQuota property with the serverAgentsQuota property of the CompanyBackupAgentsManagement schema.

• Replaced the backupAgentWorkstationQuota property with the workstationAgentsQuota property of the CompanyBackupAgentsManagement schema.

• Instead of the isBackupServerManagementEnabled property, availability of Veeam Backup & Replication server management to company users is determined by the backupServersManagement property of the CompanyRemoteServices schema. If the value of the property is null, Veeam Agent Management is not available.

• Replaced the storageQuota property with the backupServerQuota property of the CompanyBackupServerManagement schema.

• Moved the isVBPublicCloudManagementEnabled property to the CompanyRemoteServices and CompanyHostedServices schemas.

CompanySiteResource

Removed the schema.

CloudTenant

Applied the following changes.

• Added the following properties:

  • vCloudOrganizationUid.

  • assignedForCompany. Property can be used with the filter parameter to find tenants assigned to specific companies. Also it can be utilized to reassign tenants by modifying the value.

  • credentials. Property is required for tenant creation.

  • siteName.

• Changed the name of the backupServerUid property to siteUid.

• The following properties are no longer read-only:

  • type. The dafault value is General. Note that the property value cannot be changed after the tenant is created.
  • isLeaseExpirationEnabled. The default value is false.
  • leaseExpirationDate.
  • description.
  • isThrottlingEnabled. The default value is false.
  • throttlingValue. The default value is 1.
  • throttlingUnit. The default value is MbytePerSec.
  • maxConcurrentTask. The default value is 1.
  • isBackupProtectionEnabled. The default value is false.
  • backupProtectionPeriod. The default value is 7.
  • gatewaySelectionType. The default value is StandaloneGateways.
  • gatewayPoolsUids.
  • isGatewayFailoverEnabled. The default value is false.

BackupAgentJob

Added the following properties:

• backupPolicyName
• backupPolicyAssignStatus
• scheduleDisplayName
• lastModifiedDate
• lastModifiedBy
• freeSpace
• originalUid

WindowsBackupAgentJob

Added the following properties:

• description
• backupPolicyName
• backupPolicyAssignStatus

LinuxBackupAgentJob

Added the following properties:

• organizationUid
• description
• configUid
• backupPolicyUid
• backupPolicyName
• backupPolicyAssignStatus
• backupPolicyFailureMessage
• status
• operationMode
• destination
• restorePoints
• lastRun
• lastEndTime
• lastDuration
• nextRun
• avgDuration
• backupMode
• targetType
• isEnabled
• scheduleType
• lastModifiedDate
• lastModifiedBy
• failureMessage
• backedUpSize
• freeSpace

MacBackupAgentJob

Added the following properties:

• organizationUid
• description
• configUid
• backupPolicyUid
• backupPolicyName
• backupPolicyAssignStatus
• backupPolicyFailureMessage
• status
• operationMode
• destination
• restorePoints
• lastRun
• lastEndTime
• lastDuration
• nextRun
• avgDuration
• backupMode
• targetType
• isEnabled
• scheduleType
• lastModifiedDate
• lastModifiedBy
• failureMessage
• backedUpSize
• freeSpace

BackupPolicy

Applied the following changes:

• Removed the companiesCount property.

• Added the following properties:

  • id
  • companies
  • agents
  • locations

WindowsBackupPolicy

Added the following properties to the WindowsBackupPolicy schema:

• organizationUid
• name
• id
• description
• type
• accessMode
• createdBy
• modifiedDate
• companies
• agents
• locations

WindowsPersonalFilesBackupAdvancedSettings

Applied the following changes:

• Removed the mode and exclusions properies.
• Added the excludeNetworkAccount property.
• Made the inclusions property required.

LinuxBackupPolicy

Added the following properties:

• organizationUid
• id
• name
• description
• type
• accessMode
• createdBy
• modifiedDate
• companies
• agents
• locations

IdBackupAgentAssignedBackupPolicy

Added the backupPolicy property.

WindowsSharedFolderTarget

Made the credentials property nullable.

JobScheduleWindowDay

The hours property is now required and does not have a default value.

WindowsMonthlyScheduleCalendarWithDaySettings

The months property is now required and does not have a default value.

SubscriptionPlanManagedBackup

Applied the following changes.

• Added the following properties:

  • hostedManagedVmPrice
  • hostedManagedWorkstationPrice
  • hostedManagedServerAgentPrice
  • hostedFreeManagedVms
  • hostedFreeManagedCdpVms
  • hostedFreeManagedWorkstations
  • hostedFreeManagedServerAgents
  • hostedWindowsServerOsPrice
  • hostedWindowsClientOsPrice
  • hostedLinuxOsPrice
  • hostedMacOsPrice
  • hostedBackupUsedSpacePrice
  • hostedBackupUsedSpaceUnits
  • hostedFreeBackupUsedSpace
  • hostedFreeBackupUsedSpaceUnits
  • hostedRepositorySpaceUsageAlgorithm
  • hostedRepositoryAllocatedSpacePrice
  • hostedRepositoryAllocatedSpaceUnits
  • hostedRoundUpBackupUsedSpace
  • hostedBackupUsedSpaceChunkSize

• Renamed the managedVmPrice property to remoteManagedVmPrice.

• Renamed the managedCdpVmPrice property to remoteManagedCdpVmPrice.

• Renamed the managedWorkstationPrice property to remoteManagedWorkstationPrice.

• Renamed the managedServerAgentPrice property to remoteManagedServerAgentPrice.

• Renamed the freeManagedVms property to remoteFreeManagedVms.

• Renamed the freeManagedCdpVms property to remoteFreeManagedCdpVms.

• Renamed the freeManagedWorkstations property to remoteFreeManagedWorkstations.

• Renamed the freeManagedServerAgents property to remoteFreeManagedServerAgents.

• Renamed the windowsServerOsPrice property to remoteWindowsServerOsPrice.

• Renamed the windowsClientOsPrice property to remoteWindowsClientOsPrice.

• Renamed the linuxOsPrice property to remoteLinuxOsPrice.

• Renamed the macOsPrice property to remoteMacOsPrice.

• Renamed the backupUsedSpacePrice property to remoteBackupUsedSpacePrice.

• Renamed the backupUsedSpaceUnits property to remoteBackupUsedSpaceUnits.

• Renamed the freeBackupUsedSpace property to remoteFreeBackupUsedSpace.

• Renamed the freeBackupUsedSpaceUnits property to remoteFreeBackupUsedSpaceUnits.

• Renamed the repositorySpaceUsageAlgorithm property to remoteRepositorySpaceUsageAlgorithm.

• Renamed the repositoryAllocatedSpacePrice property to remoteRepositoryAllocatedSpacePrice.

• Renamed the repositoryAllocatedSpaceUnits property to remoteRepositoryAllocatedSpaceUnits.

• Renamed the roundUpBackupUsedSpace property to remoteRoundUpBackupUsedSpace.

• Renamed the backupUsedSpaceChunkSize property to remoteBackupUsedSpaceChunkSize.

SubscriptionPlanVb365

Applied the following changes.

• Added the following properties:

  • hostedSubscriptionUserPrice
  • hostedFreeSubscriptionUsers
  • hostedEducationalUserPrice
  • hostedFreeEducationalUsers
  • hostedRoundUpUsedSpace
  • hostedStandardStorageUsedSpacePrice
  • hostedStandardStorageUsedSpaceChunkSize
  • hostedStandardStorageUsedSpaceUnits
  • hostedFreeStandardStorageUsedSpace
  • hostedFreeStandardStorageUsedSpaceUnits
  • hostedArchiveStorageUsedSpacePrice
  • hostedArchiveStorageUsedSpaceChunkSize
  • hostedArchiveStorageUsedSpaceUnits
  • hostedFreeArchiveStorageUsedSpace
  • hostedFreeArchiveStorageUsedSpaceUnits
  • hostedRepositorySpaceUsageAlgorithm
  • hostedRepositoryAllocatedSpacePrice
  • hostedRepositoryAllocatedSpaceUnits

• Renamed the subscriptionUserPrice property to remoteSubscriptionUserPrice.

• Renamed the freeSubscriptionUsers property to remoteFreeSubscriptionUsers.

• Renamed the educationalUserPrice property to remoteEducationalUserPrice.

• Renamed the freeEducationalUsers property to remoteFreeEducationalUsers.

• Renamed the roundUpUsedSpace property to remoteRoundUpUsedSpace.

• Renamed the standardStorageUsedSpacePrice property to remoteStandardStorageUsedSpacePrice.

• Renamed the standardStorageUsedSpaceChunkSize property to remoteStandardStorageUsedSpaceChunkSize.

• Renamed the standardStorageUsedSpaceUnits property to remoteStandardStorageUsedSpaceUnits.

• Renamed the freeStandardStorageUsedSpace property to remoteFreeStandardStorageUsedSpace.

• Renamed the freeStandardStorageUsedSpaceUnits property to remoteFreeStandardStorageUsedSpaceUnits.

• Renamed the archiveStorageUsedSpacePrice property to remoteArchiveStorageUsedSpacePrice.

• Renamed the archiveStorageUsedSpaceChunkSize property to remoteArchiveStorageUsedSpaceChunkSize.

• Renamed the archiveStorageUsedSpaceUnits property to remoteArchiveStorageUsedSpaceUnits.

• Renamed the freeArchiveStorageUsedSpace property to remoteFreeArchiveStorageUsedSpace.

• Renamed the freeArchiveStorageUsedSpaceUnits property to remoteFreeArchiveStorageUsedSpaceUnits.

• Renamed the repositorySpaceUsageAlgorithm property to remoteRepositorySpaceUsageAlgorithm.

• Renamed the repositoryAllocatedSpacePrice property to remoteRepositoryAllocatedSpacePrice.

• Renamed the repositoryAllocatedSpaceUnits property to remoteRepositoryAllocatedSpaceUnits.

SubscriptionPlanFileShareBackup

Applied the following changes.

• Added the following properties:

  • fileShareHostedBackupUsedSpacePrice
  • fileShareHostedBackupUsedSpaceUnits
  • freeFileShareHostedBackupUsedSpace
  • freeFileShareHostedBackupUsedSpaceUnits
  • fileShareHostedArchiveUsedSpacePrice
  • fileShareHostedArchiveUsedSpaceUnits
  • freeFileShareHostedArchiveUsedSpace
  • freeFileShareHostedArchiveUsedSpaceUnits
  • sourceHostedAmountOfDataPrice
  • sourceHostedAmountOfDataUnits
  • freeSourceHostedAmountOfData
  • freeSourceHostedAmountOfDataUnits

• Renamed the fileShareBackupUsedSpacePrice property to fileShareRemoteBackupUsedSpacePrice.

• Renamed the fileShareBackupUsedSpaceUnits property to fileShareRemoteBackupUsedSpaceUnits.

• Renamed the freeFileShareBackupUsedSpace property to freeFileShareRemoteBackupUsedSpace.

• Renamed the freeFileShareBackupUsedSpaceUnits property to freeFileShareRemoteBackupUsedSpaceUnits.

• Renamed the fileShareArchiveUsedSpacePrice property to fileShareRemoteArchiveUsedSpacePrice.

• Renamed the fileShareArchiveUsedSpaceUnits property to fileShareRemoteArchiveUsedSpaceUnits.

• Renamed the freeFileShareArchiveUsedSpace property to freeFileShareRemoteArchiveUsedSpace.

• Renamed the freeFileShareArchiveUsedSpaceUnits property to freeFileShareRemoteArchiveUsedSpaceUnits.

• Renamed the sourceAmountOfDataPrice property to sourceRemoteAmountOfDataPrice.

• Renamed the sourceAmountOfDataUnits property to sourceRemoteAmountOfDataUnits.

• Renamed the freeSourceAmountOfData property to freeSourceRemoteAmountOfData.

• Renamed the freeSourceAmountOfDataUnits property to freeSourceRemoteAmountOfDataUnits.

SubscriptionPlanBackupAndReplicationLicenses

Added the following properties:

• microsoftEntraIdPrice
• cloudVmPrice
• cloudFileSharePrice
• cloudDatabasePrice

SubscriptionPlanPublicCloud

Applied the following changes.

• Added the following properties:

  • hostedCloudVmPrice
  • hostedFreeCloudVms
  • hostedCloudFileSharePrice
  • hostedFreeCloudFileShares
  • hostedCloudDatabasePrice
  • hostedFreeCloudDatabases
  • hostedBackupUsedSpacePrice
  • hostedBackupUsedSpaceUnits
  • hostedFreeBackupUsedSpace
  • hostedArchiveUsedSpacePrice
  • hostedArchiveUsedSpaceUnits
  • hostedFreeArchiveUsedSpace
  • hostedCloudNetworkPrice

• Renamed the cloudVmPrice property to remoteCloudVmPrice.

• Renamed the freeCloudVms property to remoteFreeCloudVms.

• Renamed the cloudFileSharePrice property to remoteCloudFileSharePrice.

• Renamed the freeCloudFileShares property to remoteFreeCloudFileShares.

• Renamed the cloudDatabasePrice property to remoteCloudDatabasePrice.

• Renamed the freeCloudDatabase property to remoteFreeCloudDatabases.

• Renamed the backupUsedSpacePrice property to remoteBackupSpacePrice.

• Renamed the backupUsedSpaceUnits property to remoteBackupUsedSpaceUnits.

• Renamed the freeBackupUsedSpace property to remoteFreeBackupUsedSpace.

• Renamed the archiveUsedSpacePrice property to remoteArchiveUsedSpacePrice.

• Renamed the archiveUsedSpaceUnits property to remoteArchiveUsedSpaceUnits.

• Renamed the freeArchiveUsedSpace property to remoteFreeArchiveUsedSpace.

• Renamed the cloudNetworkPrice property to remoteCloudNetworkPrice.

• Renamed the freeBackupUsedSpaceUnits property to remoteFreeBackupUsedSpaceUnits.

• Renamed the freeArchiveUsedSpaceUnits property to remoteFreeArchiveUsedSpaceUnits.

SubscriptionPlan

Added the externalPlugins property.

WindowsFileLevelBackupSource

Applied the following changes to the WindowsFileLevelBackupSource schema:

• Renamed the directories property to includeDirectories.
• Added the excludeDirectories property.

LinuxJobScheduleSettings

The monthlyScheduleSettings property now contains the new LinuxMonthlyScheduleSettingsWithTime schema instead of LinuxMonthlyScheduleSettings.

LinuxMonthlyScheduleSettings

Applied the following changes.

• Added the following properties:

  • monthlyMode
  • weekDayNumber
  • daysOfWeek
  • months

• Removed the time property.

UserBackupResource and UserBackupResourceInput

Applied the following changes:

• Renamed the companySiteBackupResourceUid property to tenantBackupResourceUid.
• The siteUid property of the UserBackupResourceInput schema is now required for companies that have no or more than one tenants assigned. In this case, if you provide the null property value, the server will return an error.

CompanySiteBackupResource

Applied the following changes:

• Changed the schema name to TenantBackupResource.
• Added the tenantUid property.

CompanySiteBackupResourceInput

Changed the schema name to TenantBackupResourceInput.

CompanySiteBackupResourceUsage

Applied the following changes:

• Changed the schema name to TenantBackupResourceUsage.
• The companyUid property is now nullable.
• Added the tenantUid property.

CompanySiteTrafficResource

Applied the following changes to the CompanySiteTrafficResource schema:

• Changed the schema name to TenantTrafficResource.
• Added the tenantUid and companyUid properties.
• The dataTransferOutQuota property now has the minimum value equal to 1 and the maximum value equal to 999424 (976 TB).

CompanySiteReplicationResource

Applied the following changes:

• Changed the schema name to TenantReplicationResource.
• The companyUid property is now nullable.

CompanySiteReplicationResourceInput

Changed the schema name to TenantReplicationResourceInput.

CompanySiteReplicationResourceHardwarePlan

Changed the schema name to TenantReplicationResourceHardwarePlan.

CompanySiteReplicationResourceNetworkAppliance

Changed the schema name to TenantReplicationResourceNetworkAppliance.

CompanySiteReplicationResourceUsage

Applied the following changes:

• Changed the schema name to TenantReplicationResourceUsage.
• The companyUid property is now nullable.

CompanySiteVcdReplicationResource

Applied the following changes:

• Changed the schema name to TenantVcdReplicationResource.
• The companyUid property is now nullable.

CompanySiteVcdReplicationResourceInput

Changed the schema name to TenantVcdReplicationResourceInput.

CompanySiteVcdReplicationResourceDataCenter

Changed the schema name to TenantVcdReplicationResourceDataCenter.

CompanySiteVcdReplicationResourceUsage

Applied the following changes:

• Changed name to TenantVcdReplicationResourceUsage.
• The companyUid property is now nullable.

CompanySiteReplicationResourceVcdNetworkAppliance

Changed the schema name to TenantReplicationResourceVcdNetworkAppliance.

LinuxActiveFullSettings

Replaced the dayOfMonth and month properties with the monthly property containing the LinuxMonthlyScheduleSettings schema. If a resource is created in older REST API versions, the time property value will be 0:00.

MacActiveFullSettings

Replaced the dayOfMonth and month properties with the monthly property containing the MacActiveFullSettings schema. If a resource is created in older REST API versions, the time property value will be 0:00.

Vb365OrganizationBase

Added the mappedOrganizationUid and mappedOrganizationName properties.

IdentityProviderRoleMappingRule

Added the companyTenantMappingClaims property.

NotificationSettings

Added the defaultSenderName property.

TestEmailOptions

Added the senderName property.

NotificationBillingSettings

Added the senderName property.

NotificationDiscoverySettings

Added the senderName property.

NotificationAlarmsSettings

Added the senderName property.

NotificationLicenseSettings

Added the senderName property.

LinuxBackupTarget

The localPath property now has a length limit of 4096 characters.

WindowsBackupTarget

The localPath property now has a length limit of 4096 characters.

BrandingSettings

Added the managedOrganizationsBrandingPolicy property.

IdentityProviderSettings

Applied the following changes:

• The configuration property now contains the new Saml2Configuration schema with stronly typed configuration instead of a string-type value. If you want to continue using XML configuration keys, you can use an older REST API version.
• The name property is now read-only.

SingleLicenseReport

Renamed the reportParemeters property to reportParameters.

SubscriptionPlanLicenses

Applied the following changes.

• Added the following properties:

  • vdpFoundationPackageLicenses
  • vdpAdvancedPackageLicenses
  • vdpPremiumPackageLicenses

• Removed the publicCloudLicenses property.

OrganizationUsageOfLicensesWithSameSupportId

Removed the tenantUid property.

OrganizationLicenseUsage

Removed the tenantUid property.

ProtectedVirtualMachine

Added the immutable property.

ProtectedVirtualMachineBackup

Added the immutable property.

ProtectedVirtualMachineBackupRestorePoint

Added the immutableTill property.

LinuxOracleArchivedLogsTruncationConfig

The maximum value of the lifeTimeHours property is now 999.

BackupServerLicense

The edition property is now nullable.

SiteLicense

The edition property is now nullable.

ResellerSiteReplicationResource

The hardwarePlanUid property of the is now read-only.

The following list contains changes applied to enums in REST API v3.6.

• Renamed the BackupPolicyType enum to BackupPolicyTypeReadonly.

• Renamed the ProductType enum to ReportProductType.

• Added the Applying value to the ManagementAgentStatus enum.

• Renamed the None value of the PublicCloudPolicyStatus enum to Idle.

• Applied the following changes to the InvoiceChargeCategory enum.

  • Added the following values:

    • ManagedHostedServer
    • ManagedHostedWorkstation
    • ManagedHostedVm
    • ManagedHostedCdpVm
    • HostedShortTermBackup
    • HostedLongTermBackup
    • HostedSourceAmountOfData
    • VbrRepositoryHostedConsumedSpace
    • VbrRepositoryHostedAllocatedSpace
    • LicStandardVbrMicrosoftEntraId
    • LicEnterpriseVbrMicrosoftEntraId
    • LicEnterprisePlusVbrMicrosoftEntraId
    • WindowsDesktopOSHosted
    • WindowsServerOSHosted
    • LinuxOSHosted
    • MacOSHosted

  • Renamed the following values:

    • ManagedVm → ManagedRemoteVm
    • ManagedServer → ManagedRemoteServer
    • ManagedWorkstation → ManagedRemoteWorkstation
    • ManagedCdpVm → ManagedRemoteCdpVm
    • ShortTermBackup → RemoteShortTermBackup
    • LongTermBackup → RemoteLongTermBackup
    • SourceAmountOfData → RemoteSourceAmountOfData
    • VbrRepositoryConsumedSpace → VbrRepositoryRemoteConsumedSpace
    • VbrRepositoryAllocatedSpace → VbrRepositoryRemoteAllocatedSpace
    • WindowsDesktopOS → WindowsDesktopOSRemote
    • WindowsServerOS → WindowsServerOSRemote
    • LinuxOS → LinuxOSRemote
    • MacOS → MacOSRemote

• Renamed the following values in the WindowsJobStorageOptimization and LinuxJobBlockSize enum:

  • Local100TbPlusBackup → LocalPb4MB
  • Local → Local1MB
  • Lan → Lan512KB
  • Wan → Wan256KB

• Added the CompanyTenant value to the UserRole and SsoRoles enums.

• The following values of the CompanyStatus enum are now considered removed and cannot be used in requests:

  • Expired (renamed to REMOVED_Expired)
  • Creating (renamed to REMOVED_Creating)
  • Deleting (renamed to REMOVED_Deleting)
  • Deleted (renamed to REMOVED_Deleted)
  • SiteResourceCreationFailed (renamed to REMOVED_SiteResourceCreationFailed)
  • SiteResourceCreating (renamed to REMOVED_SiteResourceCreating)
  • SiteResourceUpdating (renamed to REMOVED_SiteResourceUpdating)
  • SiteResourceUpdateFailed (renamed to REMOVED_SiteResourceUpdateFailed)

• Added the following values to the VeeamLicensePackage and ConsoleLicensePackage enums:

  • Foundation
  • Advanced
  • Premium

• Added the VDP value to the ReportProductType enum.

• Added the following values to the AggregatedUsageType enum:

  • PublicCloudProtectedFileShares
  • PublicCloudProtectedCloudDatabases
  • PublicCloudBackupSize
  • PublicCloudArchiveSize
  • ManagedCdpVms

• Added the following values to the ActivityLogType enum:

  • VbrUidRegenerated
  • VOneUidRegenerated
  • ProxySessionOpened
  • ProxySessionClosed
  • TenantCreated
  • TenantModified
  • TenantRemoved
  • TenantEnabled
  • TenantDisabled
  • TenantAssigned
  • TenantUnassigned

• Added the SobrMaintenance value to the BackupServerJobType enum.

The following list contains IDs of new operations introduced in REST API v3.6.

• CreateTenant
• CreateTenantBackupResource
• CreateTenantReplicationResource
• CreateTenantVcdReplicationResource
• DeleteTenant
• DeleteTenantBackupResource
• GetTenantBackupResource
• GetTenantBackupResources
• GetTenantBackupResourcesUsage
• GetTenantReplicationResourceHardwarePlan
• GetTenantReplicationResources
• GetTenantReplicationResourcesNetworkAppliance
• GetTenantReplicationResourcesNetworkAppliances
• GetTenantReplicationResourcesUsage
• GetTenantTrafficResource
• GetTenantVcdReplicationResourceDataCenter
• GetTenantVcdReplicationResources
• GetTenantVcdReplicationResourcesNetworkAppliance
• GetTenantVcdReplicationResourcesNetworkAppliances
• GetTenantVcdReplicationResourcesUsage
• GetTenantsBackupResources
• GetTenantsBackupResourcesUsages
• GetTenantsReplicationResources
• GetTenantsReplicationResourcesUsages
• GetTenantsVcdReplicationResources
• GetTenantsVcdReplicationResourcesUsages
• PatchTenant
• PatchTenantBackupResource
• PatchTenantReplicationResource
• PatchTenantReplicationResourcesNetworkAppliance
• PatchTenantTrafficResource
• PatchTenantVcdReplicationResource
• PatchTenantVcdReplicationResourcesNetworkAppliance

GetEntityPermissions PatchEntityPermissions

• GetHostedAgentLinux
• InstallVOneServerOnDiscoveryComputer
• ScheduleInstallVOneServerOnDiscoveryComputer
• ScheduleUpgradeVOneServer
• UpgradeVOneServer

• AbortVOneServerMultipartPatch
• CompleteVOneServerMultipartPatch
• CreateMacBackupAgentJobConfiguration
• CreateMacBackupPolicy
• CreateVOneServerMultipartPatch
• DiscoverActiveDirectoryTree
• GetActiveProxySessions
• GetJobSessionHeatmap
• GetMacBackupAgentJobConfiguration
• GetMacBackupPolicies
• GetMacBackupPolicy
• GetManagementAgentInstalledProxyableProducts
• PatchMacBackupAgentJobConfiguration
• PatchMacBackupPolicy
• PredownloadVOneServerIso
• PredownloadVOneServerIsoOnDiscoveryComputer
• UploadVOneServerMultipartPatch

• CreateResellerVbrResource
• DeleteResellerVbrResource
• GetResellerVbrResource
• GetResellerVbrResources
• GetResellersVbrResources
• PatchResellerVbrResource

• GetPlugin
• UninstallPlugin
• AssignApiKey
• UpdateOrganizationRules
• UpdateAgentRules
• EnableDisablePlugin
• GetPluginUserIsLogged
• GetAllPlugins
• GetPluginVersions
• GetPluginCharges