Breaking Changes

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

  • Veeam ONE servers now have new UIDs that are returned as the instanceUid property values. The old UIDs can no longer be obtained or used. The following operations were affected:
  • GetVOneServers
  • GetVOneServer
  • GetVOneServerSettings
  • UpdateVOneServerSettings
  • ForceCollectVOneServer
  • GetVOneServersLicenses
  • GetVOneServerLicense
  • InstallVOneServerLicense
  • DeleteVOneServerLicense
  • PatchVOneServerLicense
  • UpdateVOneServerLicense
  • GetOrganizationsLicenseUsage
  • Veeam Backup & Replication server jobs now have new UIDs that are returned as the instanceUid property values. The old UIDs can be obtained as the originalUid property values and used as input parameters. We recommend that you use the new UIDs, however, for requests related to protected workloads, the originalUid property values are required.
  • Async actions no longer include body and query parameters of the original request. To attach this information to an async action, use the AttachRequestDataToAsyncAction operation.
  • We limited access to repository sensitive data for the users that lack required privileges. It was implemented in the following operations:
  • GetBackupRepositories
  • GetBackupRepositoriesByServer
  • GetBackupRepository

The way access limitations affect the response data depends on the REST API version:

  • For REST API v3.5, the sensitive data resides under the embedded response property. To access this property contents, a user with required privileges must provide the BackupRepositoryInfo value for the expand query parameter of a request. If a user is not permitted to access sensitive data, the embedded property will have the null value.
  • For REST API v3.3 and v3.4, if a user is not permitted to access repository sensitive data, that user will not receive a resource representation of that repository in a response.

Page updated 10/15/2024

Page content applies to build 8.1.0.21999