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

Proxied requests now return now return the 502 Bad Gateway error code in case of proxy issues. Previously, responses were returned with an empty body.

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

• Deleted the REMOVED_ prefix from the following values of the CompanyStatus enum to fix filtering and sorting issues:

  • REMOVED_Expired (renamed to Expired)
  • REMOVED_Creating (renamed to Creating)
  • REMOVED_Deleting (renamed to Deleting)
  • REMOVED_Deleted (renamed to Deleted)
  • REMOVED_SiteResourceCreationFailed (renamed to SiteResourceCreationFailed)
  • REMOVED_SiteResourceCreating (renamed to SiteResourceCreating)
  • REMOVED_SiteResourceUpdating (renamed to SiteResourceUpdating)
  • REMOVED_SiteResourceUpdateFailed (renamed to SiteResourceUpdateFailed) Active and Disabled remain the only valid values.

• Changed collection method of the instanceUid value of the BackupFailoverPlanObject schema. Previously, it was collected directly from Veeam Backup & Replication PowerShell output which returned empty values for cloud failover plan objects. For that reason, instanceUid had the 00000000-0000-0000-0000-000000000000 value. Now the value is collected from the database using the VM host reference and Veeam Backup & Replication server.

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.2.

• In the GetBackupServerBackupVmJobs and GetBackupServerBackupVmJobsByServer operations, backup jobs for various supported platforms (Nutanix AHV, oVirt/KVM, Proxmox VE and others) are now represented by a single parent policy job. Internal worker jobs are no longer included in the response, which eliminates duplicate entries and the incorrect protectedVmCount: 0 values. The _embedded.backupServerJob expand is now correctly populated for these jobs.
• For supported platform backup jobs, only UID of a parent policy job is accepted as the jobUid parameter value of the GetBackupServerBackupVmJob operation. If you specify UID of a worker job, the 404 Not Found error will be returned.
• The GetBackupServerBackupVmJobsObjects, GetBackupServerBackupVmJobsObjectsByServer, GetBackupServerBackupVmJobObjects operations now return job objects for all supported platforms.
• Added the educationalFilter and licensedFilter filter parameters for the GetVb365ProtectedObjects operation.
• Applied the following changes to the DeleteVb365Server operation:
  • Now deletes only the server data from the Veeam Service Provider Console database. Management agent remains installed on the server.
  • Now works for both hosted and client servers.

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

• Added the excludeDirectories property to the LinuxFileLevelBackupSource schema.
• Added the includeCsv property to the NotificationLicenseSettings schema.
• Added the isHardQuotaEnabled property to the CompanyBackupAgentsManagement schema.
• Added the following properties to the PolicySettings schema:
  • powerShellSessionsEnabled
  • powerShellSessionsEnabledByManager
  • redirectingToVbrWebUIEnabled
  • redirectingToVbrWebUIEnabledByManager
  • redirectingToVbrWizardEnabled
  • redirectingToVbrWizardEnabledByManager
  • restApiProxyingEnabled
  • restApiProxyingEnabledByManager
• Added the vb365ServerOwnership property to the Vb365Job schema.
• Added the isRestorePortalAccessEnabled property to the Vb365ProtectedObject schema.
• Added the tags property to the BackupRepository schema.

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

• Added the following values to the BackupServerVmJobObjectPlatform enum:
  • NutanixAhv
  • ProxmoxVe
  • OVirtKvm
  • ScaleComputing
  • HpeMorpheusVmEssentials
• Added the HpeMorpheusVmEssentials value to the following enums:
  • BackupServerBackupVmJobHypervisorType
  • CloudBackupType
  • JobSessionHeatmapPlatformType
• Added the following values to the ActivityLogType enum:
  • DeploymentTaskCancelled
  • DeploymentTaskRescheduled
  • DeploymentTaskScheduleCancelled
  • DeploymentTaskScheduled
  • DeploymentTaskStarted
  • VOneIsoPredownloadCancelled
  • VOneIsoPredownloadStarted
  • VbrFailoverPlanScriptSet
  • VbrFailoverPlanStarted
  • VbrFailoverPlanStopped
  • VbrRepositoryCreated
  • VbrRepositoryRemoved
  • VbrRepositoryUpdated
  • VdcBackupServerRegistered
  • VdcBackupServerUnregistered
  • VdcTenantCreated
  • VdcTenantMappingCreated
  • VdcTenantMappingRemoved
  • VdcVaultAssigned
  • VdcVaultCreated
  • VdcVaultRemoved
  • VdcVaultUnassigned
  • VdcVaultUpdated
• Added the following values to the AggregatedUsageType enum:
  • VdcVaultAzureAdvancedCoreUsedSpace
  • VdcVaultAzureAdvancedNonCoreUsedSpace
  • VdcVaultAzureFoundationCoreUsedSpace
  • VdcVaultAzureFoundationNonCoreUsedSpace
• Applied the following changes to the PermissionClaims enum:
  • Renamed the following values:
    • PublicCloudJobCreate → HostedPublicCloudJobCreate
    • PublicCloudJobEdit → HostedPublicCloudJobEdit
    • PublicCloudJobDelete → HostedPublicCloudJobDelete
    • PublicCloudJobStartStop → HostedPublicCloudJobStartStop
    • PublicCloudJobEnableDisable → HostedPublicCloudJobEnableDisable
  • Added the following values:
    • HostedPublicCloudRestore
    • HostedVbm365Restore
    • RemoteVbrJobEdit
    • RemoteVbrJobDelete
    • RemoteVbrJobStartStop
    • RemoteVbrJobEnableDisable
    • RemoteVbm365JobCreate
    • RemoteVbm365JobEdit
    • RemoteVbm365JobDelete
    • RemoteVbm365JobStartStop
    • RemoteVbm365JobEnableDisable
    • RemoteVbm365JobScopeWrite
    • RemoteVbm365JobRepositoryWrite
    • RemoteVbm365JobScheduleWrite
    • RemoteVbm365Restore
    • RemotePublicCloudJobStartStop
    • RemotePublicCloudJobEnableDisable

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

• GetDefaultMountServer
• GetMountServer
• GetMountServers

• AssignTenant

• ForceCollectEnterpriseManager

• AbortLinuxBackupServerMultipartPatch
• AssignVdcStorageVaultToBackupServer
• CompleteLinuxBackupServerMultipartPatch
• CompleteVdcVaultRegistration
• CreateBackupServerVeeamVaultRepository
• CreateBackupServerWinLocalRepository
• CreateLinuxBackupServerMultipartPatch
• CreateVdcStorageVault
• CreateVdcVaultBackupServerAssignedVaultFolder
• CreateVdcVaultTenant
• CreateVdcVaultTenantMapping
• DeleteBackupServerRepository
• GetBackupServerVeeamVaultRepository
• GetBackupServerWinLocalRepository
• GetRegisteredVdcVaultBackupServer
• GetRegisteredVdcVaultBackupServers
• GetVdcStorageVault
• GetVdcStorageVaults
• GetVdcVaultBackupServerAssignedVault
• GetVdcVaultBackupServerAssignedVaultFolders
• GetVdcVaultBackupServerAssignedVaults
• GetVdcVaultConfiguration
• GetVdcVaultRegistrationData
• GetVdcVaultSubscription
• GetVdcVaultSubscriptionCountries
• GetVdcVaultSubscriptions
• GetVdcVaultTenant
• GetVdcVaultTenants
• PatchBackupServerVeeamVaultRepository
• PatchBackupServerWinLocalRepository
• PatchVdcStorageVault
• RegisterVdcVaultBackupServer
• RemoveVdcStorageVault
• RemoveVdcVaultRegistration
• RemoveVdcVaultTenantMapping
• SyncVdcVault
• UnassignVdcStorageVaultFromBackupServer
• UnregisterVdcVaultBackupServer
• UploadLinuxBackupServerMultipartPatch