Veeam Service Provider Console 9.3
REST API Reference
Related documents

Changelog

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

Breaking Changes

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

  • All GET /infrastructure/backupServers/{backupServerUid}/jobs/* endpoints now return the 403 Forbidden error when the requesting user does not have access to the specified backup server. Previously, these endpoints returned 200 OK with an empty collection.

  • Changed the collection method of the instanceUid value of the BackupServerHost schema for local hosts. Previously, instanceUid was collected directly from Veeam Backup & Replication, which returned a hardcoded GUID (6745a759-2205-4cd2-b172-8ec8f7e60ef8) for all local hosts across all backup servers. For that reason, the GetBackupServerHosts operation returned duplicate instanceUid values when several backup servers had local hosts. Now the value is derived from the Veeam Backup & Replication server UID and the original Veeam Backup & Replication host UID, so it is unique for each backup server. After the upgrade, the instanceUid property value in the BackupServerHost schema becomes different from the values in the previous versions.

  • For the BackupWanAccelerator schema, changed the collection method of the hostUid value for WAN accelerators installed on a local host. Previously, hostUid was collected directly from Veeam Backup & Replication, which returned the same hardcoded GUID for all local hosts. For that reason, WAN accelerators on different backup servers shared the same hostUid. Now the value is derived from the Veeam Backup & Replication server UID and the original Veeam Backup & Replication host UID. After the upgrade, the hostUid property values for these WAN accelerators will become different from the values in the previous versions.

  • The linkedJobUid value of the BackupServerJobLinkedJobObject schema now consistently contains the uniqueUid property value of the linked source job for all backup copy jobs. Previously, legacy advanced-mode periodic backup copy jobs created before Veeam Backup & Replication 12 returned the Veeam Backup & Replication instanceUid, while all other job types already returned uniqueUid. This change applies to all REST API versions through the historical downcast layer. After you upgrade, you will receive different linkedJobUid property values from the ones received from advanced-mode periodic backup copy jobs. Single-job lookup endpoints such as GET /infrastructure/backupServers/jobs/{jobUid} continue to accept both instanceUid and uniqueUid.

  • Changed the behavior of the EnableOrganizationAlarms (POST /organizations/{organizationUid}/configuration/alarms/enable) operation. Previously, EnableOrganizationAlarms switched every predefined alarm template of an organization to the enabled state. Now the operation turns alarm detection on, but does not enable every template. A subset of predefined templates stays disabled by default to avoid excessive alarms. This subset matches the default set used for newly created organizations. This change applies to all REST API versions.

  • Aligned the meaning of the isAlarmDetectEnabled property of the Company and CompanyInput schemas with the organization-level alarm detection status. Previously, the response value was derived from whether an organization had at least one enabled alarm template. For the same underlying configuration, the returned value may differ from the value in previous versions. Also, when you create or patch a company, this property no longer enables every individual alarm template. This change applies to all REST API versions.

Resource Changes

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

Operation Changes

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

  • Renamed the immediate backup copy job operations. The route base path changed from /infrastructure/backupServers/jobs/simpleBackupCopyJobs to /infrastructure/backupServers/jobs/immediateBackupCopyJobs, including the {backupServerUid} and object variants. Historical REST API versions keep the previous routes, operation names and model names.
    • GetBackupServerSimpleBackupCopyJobs → GetBackupServerImmediateBackupCopyJobs
    • GetBackupServerSimpleBackupCopyJob → GetBackupServerImmediateBackupCopyJob
    • GetBackupServerSimpleBackupCopyJobsByServer → GetBackupServerImmediateBackupCopyJobsByServer
    • GetBackupServerSimpleBackupCopyJobsLinkedJobObjects → GetBackupServerImmediateBackupCopyJobsLinkedJobObjects
    • GetBackupServerSimpleBackupCopyJobLinkedJobObjects → GetBackupServerImmediateBackupCopyJobLinkedJobObjects
    • GetBackupServerSimpleBackupCopyJobsLinkedJobObjectsByServer → GetBackupServerImmediateBackupCopyJobsLinkedJobObjectsByServer
  • Added the expand query parameter accepting the backupServerJob value to the following operations:
    • GetBackupServerBackupCopyJob
    • GetBackupServerImmediateBackupCopyJob (previously GetBackupServerSimpleBackupCopyJob)
    • GetBackupServerVmCopyJob
    • GetBackupServerFileShareCopyJob
    • GetBackupServerObjectStorageBackupCopyJob
    • GetBackupServerAgentJob
    • GetBackupServerBackupTapeJob
    • GetBackupServerCdpReplicationJob
    • GetBackupServerFileCopyJob
    • GetBackupServerFileShareJob
    • GetBackupServerFileTapeJob
    • GetBackupServerObjectStorageBackupJob
    • GetBackupServerReplicationVmJob
  • Removed the VerifyPublicCloudApplianceCertificate operation. The public cloud web proxy now works without explicit certificate verification, so the operation is no longer needed. In previous REST API versions, the operation only updates the certificate thumbprint on the Web UI side.
  • The GetActiveProxySessions operation now returns plain REST API proxy sessions only. Full-UI and wizard proxy sessions are now monitored by the dedicated GetActiveUiProxySessions and GetActiveWizardProxySessions operations.
  • The following operations are fully functional and are no longer present under the Preview Operations tag:
    • DiscoverActiveDirectoryTree
    • GetManagementAgentInstalledProxyableProducts
    • GetActiveProxySessions
    • GetManagementAgentCredentials
    • SetManagementAgentCredentials
    • DeleteManagementAgentCredentials
    • GetVdcVaultConfiguration
    • GetVdcVaultRegistrationData
    • CompleteVdcVaultRegistration
    • RemoveVdcVaultRegistration
    • GetVdcVaultSubscriptions
    • GetVdcVaultSubscription
    • GetVdcVaultSubscriptionCountries
    • CreateVdcVaultTenant
    • GetVdcVaultTenants
    • GetVdcVaultTenant
    • CreateVdcVaultTenantMapping
    • RemoveVdcVaultTenantMapping
    • SyncVdcVault
    • CreateVdcStorageVault
    • GetVdcStorageVaults
    • GetVdcStorageVault
    • RemoveVdcStorageVault
    • PatchVdcStorageVault
    • GetRegisteredVdcVaultBackupServers
    • RegisterVdcVaultBackupServer
    • GetRegisteredVdcVaultBackupServer
    • UnregisterVdcVaultBackupServer
    • GetVdcVaultBackupServerAssignedVaults
    • AssignVdcStorageVaultToBackupServer
    • GetVdcVaultBackupServerAssignedVault
    • UnassignVdcStorageVaultFromBackupServer
    • GetVdcVaultBackupServerAssignedVaultFolders
    • CreateVdcVaultBackupServerAssignedVaultFolder
  • Read access to licensing information is now available to the Company Administrator and Company Owner roles. The routes, parameters and response models are unchanged. The change applies to the following operations:
    • Per-product license information for Veeam Backup & Replication: GetBackupServerLicense and GetBackupServersLicenses.
    • Per-product license information for Veeam Backup for Microsoft 365: GetVb365ServerLicense and GetVb365ServersLicenses.
    • Per-product license information for Veeam ONE: GetVOneServerLicense and GetVOneServersLicenses.
    • Licensing reports: GetLicensingReports, GetLatestLicensingReports, GetLicensingReportsForDate and DownloadLicensingReportCsv.
    • Organization license usage: GetOrganizationsLicenseUsage.
    • Pulse configuration: GetPulseConfiguration.

Schema Changes

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

  • Renamed the repository and agent tagging feature to labels, to distinguish it from Veeam Backup & Replication tags. The following properties were renamed as a result. Historical REST API versions keep the previous property names through the downcast layer.
    • ManagementAgent.tag → ManagementAgent.agentLabel
    • UnverifiedAgent.tag → UnverifiedAgent.agentLabel
    • BackupRepository.tags → BackupRepository.labels
  • Added the repositoryUsageByLabel property to the SubscriptionPlanManagedBackup schema.
  • Added the useRepositoryUsageByLabelHosted property to the SubscriptionPlanManagedBackup schema.
  • Added the useRepositoryUsageByLabelRemote property to the SubscriptionPlanManagedBackup schema.
  • Added the clusteredAgentUids property to the ManagementAgent schema.
  • Added the legalName and domain properties to the Organization and OrganizationInput schemas.
  • Added the labelTargetUid property to the BackupRepository schema.
  • Added the schedule property to the Alarm schema.
  • Added the custom property to the AlarmKnowledge schema.
  • Added the label property to the BackupAgent, BackupServer and DiscoveredComputer schemas.
  • Added the isWholeServerAssigned property to the CompanyHostedVbrResource and CompanyHostedVbrResourceInput schemas.
  • Added the webhooksEnabled and webhooksEnabledByManager properties to the PolicySettings schema.
  • Added the platform and vaultType properties to the VdcStorageVault schema.
  • Added the displayName, categoryName, repositoryLabelInfo and externalChargeInfo properties to the InvoiceCharge schema.
  • The category property of the InvoiceCharge schema previously returned Unknown for repository-usage-by-label charges and external plugin charges. It now returns the specific RepoUsageByLabel* and External values.
  • Added the tier property to the ProtectedVirtualMachineBackupRestorePoint schema.
  • Increased the maximum allowed value from 730 to 9999 for the following retention properties:
    • restorePointsCount and retentionDays of the LinuxJobRetentionSettings schema.
    • restorePointsCount and retentionDays of the MacJobRetentionSettings schema.
    • retentionDays of the WindowsWorkstationJobRetentionSettings schema.
    • retentionCount of the WindowsServerJobRetentionSettings schema.
  • Added the hostUid and hostName properties to the VirtualServerTag and BackupServerVirtualMachine schemas.
  • Renamed the BackupServerSimpleBackupCopyJob schema to BackupServerImmediateBackupCopyJob.

Enum Changes

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

  • Added the following values to the BackupRepositoryType enum:
    • AbrVirtual
    • VeeamVaultArchive
    • VeeamVaultExternal
  • Added the Aws value to the VdcVaultSubscriptionType enum.
  • Added the following values to the AggregatedUsageType enum:
    • VdcVaultAwsAdvancedCoreUsedSpace
    • VdcVaultAwsAdvancedNonCoreUsedSpace
    • VdcVaultAwsFoundationCoreUsedSpace
    • VdcVaultAwsFoundationNonCoreUsedSpace
  • Added the Orphaned value to the ProtectedVirtualMachineBackupType enum.
  • Added the following values to the BackupServerBackupVmJobHypervisorType, BackupServerVmJobObjectPlatform, CloudBackupType and JobSessionHeatmapPlatformType enums:
    • KubeVirt
    • SangforAsv
    • XCP_ng
  • Added the VeeamSoftwareAppliance value to the SupportCaseProductType enum.
  • Added the following values to the SupportCaseCategory enum:
    • VeeamSoftwareAppliance_BackupJobs
    • VeeamSoftwareAppliance_Configuration
    • VeeamSoftwareAppliance_General
    • VeeamSoftwareAppliance_Licensing
  • Added the following values to the InvoiceChargeCategory enum:
    • External
    • RepoUsageByLabelRemote
    • RepoUsageByLabelHosted
    • RepoUsageByLabelRemoteUnspecified
    • RepoUsageByLabelHostedUnspecified
  • Renamed the BackupServerSimpleBackupCopyJobExpand enum to BackupServerImmediateBackupCopyJobExpand.

New Operations

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

Cloud Connect