Veeam Service Provider Console 9
REST API Reference
Related documents
Search

Schema Changes

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

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 backup agent management to company users is determined by the backupAgentsManagement property of the CompanyRemoteServices schema. If the value of the property is null, Veeam backup 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 backup 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
  • hostedManagedCdpVmPrice
  • 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.

Page updated 9/5/2025

Page content applies to build 9.0.0.29555

View all results across Veeam Help Center
Back to document search