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

REST API v3.5.1 Changes

The following changes were introduced in REST API v3.5.1.

Breaking Changes

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

  • The instanceUid property of resources representing Veeam Backup & Replication server jobs now contains job UID assigned in Veeam Backup & Replication. The same applies to REST API v3.4 and earlier versions. In REST API v3.5, the instanceUid property contains job UID assigned in Veeam Service Provider Console.
  • The useWeeklyFullBackupForTheFollowingWeekOfMonth property of the WindowsGfsMonthlyRetentionSettings schema now contains the WeekOfMonth enum that has the following possible values: First, Second, Third, Fourth, Last. Older version clients will receive the First value in case the server returns the First, Second, Third and Fourth values.
  • Offload jobs are no longer returned in the GetBackupServerJobs request response. Previously they were returned as jobs with the Unknown value in the Type property.

Resource Changes

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

  • Added the uniqueUid property to the following schemas:
  • BackupServerJob
  • BackupServerFileShareJob
  • BackupServerBackupCopyJob
  • BackupServerSimpleBackupCopyJob
  • BackupServerFileShareCopyJob
  • BackupServerObjectStorageBackupCopyJob
  • BackupServerObjectStorageBackupJob
  • BackupServerFileCopyJob
  • BackupServerVmCopyJob
  • BackupServerBackupTapeJob
  • BackupServerFileTapeJob
  • BackupServerBackupVmJob
  • BackupServerCdpReplicationJob
  • BackupServerReplicationVmJob
  • BackupServerAgentJob
  • BackupServerAgentJobObject
  • Added the uniqueJobUid property to the following schemas:
  • BackupServerFileShareJobObject
  • BackupServerFileShareCopyJobObject
  • BackupServerObjectStorageBackupJobObject
  • BackupServerObjectStorageBackupCopyJobObject
  • BackupServerJobLinkedJobObject
  • BackupServerJobLinkedRepositoryObject
  • BackupServerCdpReplicationJobObject
  • BackupServerVmJobObject
  • BackupServerAgentJobObject
  • Added the sourceFileShareJobUniqueUid property to the BackupServerFileShareCopyJob schema.
  • Removed the originalUid property from the BackupServerJob schema.
  • Added the ElevenEleven value to the BackupRepositoryType enum.

Page updated 11/12/2025

Page content applies to build 8.1.0.21999