This section describes changes introduced in Veeam Backup & Replication REST API 1.3-rev1.

To use the latest revision of the REST API, specify the 1.3-rev1 value in the x-api-version header of each request. For details on REST API versions, see Versioning.

The 1.3-rev1 value is added for the x-api-version header. The header must be specified in each request. For details on REST API versions, see Versioning.

The following new features are introduced in Veeam Backup & Replication REST API 1.3-rev1.

Veeam Backup & Replication REST API 1.3-rev1 now allows you to perform the following operations with Veeam Agents:

• Create backup policies managed by Veeam Agent
• Create protection groups for cloud machines
• Upgrade the Agent and manage the CBT driver on Windows machines
• Create Veeam Recovery Media

Note that all requests under the Protection Group tag in previous revisions have been moved under the Agents tag.

New Operations

Jobs

• Apply Backup Policy Configuration
• Clear Backup Cache

Backup Objects

• Create Recovery Media for Backup Object

Cloud Browser

• Get Cloud Virtual Machines

Agents

• Upgrade Agent on Discovered Entities
• Install CBT Driver on Discovered Entities
• Uninstall CBT Driver from Discovered Entities
• Add Discovered Entities to Trusted Hosts List
• Create Recovery Media for Discovered Entity

Updated Schema

• You can use existing endpoints to create backup policies managed by Veeam Agent:
  • The JobModel object has been updated with the following child schemas:
    • WindowsAgentManagementBackupWorkstationPolicyModel
    • WindowsAgentManagementBackupServerPolicyModel
    • LinuxAgentManagementBackupWorkstationPolicyModel
    • LinuxAgentManagementBackupServerPolicyModel
  • The JobSpec object has been updated with the following child schemas:
    • WindowsAgentManagementBackupWorkstationPolicySpec
    • WindowsAgentManagementBackupServerPolicySpec
    • LinuxAgentManagementBackupWorkstationPolicySpec
    • LinuxAgentManagementBackupServerPolicySpec
  • The following types have been added to the EJobType enumeration type:
    • WindowsAgentBackupWorkstationPolicy
    • LinuxAgentBackupWorkstationPolicy
    • WindowsAgentBackupServerPolicy
    • LinuxAgentBackupServerPolicy
• You can use existing endpoints to create and manage protection groups for cloud machines:
  • The Unmanaged and CloudMachines types have been added to the EProtectionGroupType enumeration type.
  • The ProtectionGroupModel object now has the UnmanagedProtectionGroupModel and CloudMachinesProtectionGroupModel child schemas.
  • The CloudMachinesProtectionGroupSpec child schema has been added to the ProtectionGroupSpec object.
• The Add Protection Group and Edit Protection Group requests now have the performRescan parameter, which allows you to automatically start a rescan if the settings are saved successfully.
• The relatedSessionId property has been added to the SessionModel object. This property contains a rescan session triggered when creating or modifying a protection group.
• The vss property of the LinuxAgentBackupApplicationSettingsModel object is no longer required.
• The AgentOperationPurgeCache type has been added to the ESessionType enumeration type.

REST API 1.3-rev1 introduces new endpoints that allow you to protect your unstructured data.

New Operations

Inventory Browser

• Add Unstructured Data Servers
• Edit Unstructured Data Server
• Remove Unstructured Data Server

Backups

• Run Health Check and Repair

Backup Browsers

• Restore Files and Folders from Unstructured Data Backup
• Compare Attributes of Unstructured Data Backup with Source
• Compare Files and Folders of Unstructured Data Backup with Source

Restore

• Restore Entire File Share
• Restore Entire Bucket or Container
• Get All Mount Points for Instant File Share Recovery
• Start Instant File Share Recovery
• Get Mount Point for Instant File Share Recovery
• Stop File Share Publishing
• Start File Share Migration
• Start File Share Switchover
• Get File Share Switchover Settings
• Update File Share Switchover Settings
• Start File Restore from Unstructured Data Backup
• Unmount Unstructured Data FLR Volumes

Updated Schema

Note the following changes:

• The typeFilter parameter has been added to the Get All Unstructured Data Servers request, which allows you to filter unstructured data servers by their type.
• The FileInstantRecovery and FileInstantRecoveryMigration types have been added to the ESessionType enumeration type.
• The JobModel object has been updated with the following child schemas:
  • FileBackupJobModel
  • ObjectStorageBackupJobModel
• The JobSpec object has been updated with the following child schemas:
  • FileBackupJobSpec
  • ObjectStorageBackupJobSpec
• The following types have been added to the EJobType enumeration type:
  • FileBackup
  • ObjectStorageBackup

Veeam Backup & Replication REST API 1.3-rev1 introduces new requests that allow you to manage Veeam Backup & Replication users, groups and assigned roles.

New Operations

• Get All Users and Groups
• Add User or Group
• Get User or Group
• Remove User or Group
• Get User Roles
• Edit User Roles
• Change Service Account Mode
• Reset MFA for Specific User
• Get All Roles
• Get Role
• Get Role Permissions
• Get MFA Settings
• Edit MFA Settings

Veeam Backup & Replication REST API 1.3-rev1 now allows you to modify the general options in a more granular manner. The previous requests have been deprecated — for more information, see Deprecated Requests.

New Operations

• Get Email Settings
• Update Email Settings
• Send Test Email
• Get Notification Settings
• Edit Notification Settings
• Get Event Forwarding Settings
• Edit Event Forwarding Settings
• Get Storage Latency Settings
• Edit Storage Latency Settings
• Add Latency Settings for Specific Datastore
• Get Latency Settings for Specific Datastore
• Edit Latency Settings for Specific Datastore
• Remove Latency Settings for Specific Datastore

In this version, the REST API has the new Copy Backups to Another Repository request, which allows you to perform a one-time copy of backups to a specified target repository and, if specified, archive repository.

REST API 1.3-rev1 introduces the Get Logs for SureBackup Scan Task Session request, which allows you to get detailed logs about the progress of the SureBackup Lite job.

The following requests are deprecated in REST API 1.3-rev1:

• Get General Options
• Edit General Options

The following minor non-breaking changes are introduced in REST API 1.3-rev1.

The UniversalCdpWindows type has been added to the ELicensePlatformType enumeration type.

The Get All Helper Appliances request now accepts the skip and limit parameters, which allow you to skip helper appliances and limit the number of helper appliances returned by the request.

• The Get All Restore Sessions of Microsoft Entra ID Tenant request now accepts the skip and limit parameters, which allow you to skip restore sessions and limit the number of restore sessions returned by the request.
• The restorePointId and restorePointDate properties of the EntraIdTenantBrowseModel object are no longer required.
• The includedTypes property has been added to the EntraIdTenantDeviceConfigurationFilterBrowseSpec object.
• The restoreType property has been added to the FileBackupFLRCopyToSpec object.

• The Get All Malware Events request now accepts the createdAfterTimeUtcFilter and createdBeforeTimeUtcFilter parameters, which allow you to filter malware events by the time they were created.
• The pagination property of the YaraRulesResult object is now required.

The CockpitMessage type has been added to the EAuthorizationEventState enumeration.

The protectionScope property has been added to the EntraIDTenantModel and EntraIDTenantSpec objects.

• The enableAutoProvision and workloadsPerBucketLimit properties have been added to the S3CompatibleStorageBucketModel object.
• The credentialsId property of the SmbRepositoryShareSettingsModel object is no longer required.
• The importOptions property has been added to the LinuxHardenedStorageModel, LinuxLocalStorageModel, NfsStorageModel,SmbStorageModel and WindowsLocalStorageModel objects. The property allows Veeam Backup & Replication to search the repository for existing backups and import them automatically.

The Get Backup Objects request now accepts the skip and limit parameters, which allow you to skip backup objects and limit the number of backup objects returned by the request.

The Get Restore Points request now accepts the skip, limit, orderColumn, orderAsc, createdAfterFilter, createdBeforeFilter, nameFilter, platformNameFilter, platformIdFilter, backupIdFilter, backupObjectIdFilter and malwareStatusFilter parameters, which allow you to filter restore points returned by the request.

• The Edit Job request now has the allowOldGfsPointsRetention parameter, which allows you to remove existing GFS restore points when you modify the GFS retention policy.
• The EHypeVProxyType property has been renamed to EHyperVProxyType.

The Get All Instant Recovery Mount Points of VMware vSphere VMs request now has the mountIdFilter parameter, which allows you to filter mount points by the mountId property.

The Get Restore Point Disks request now accepts the skip and limit parameters, which allow you to skip restore point disks and limit the number of restore point disks returned by the request.

• The reason property has been added to the PublishBackupContentSpec object.
• The targetServerCredentialsId and singleUseSSHCredentials properties have been added to the FUSELinuxMountSpec object.

• The Type type has been added to the EEntraIdTenantDeviceConfigurationSortingProperty enumeration type.
• The BackupCopyJob and SureBackupContentScan types have been added to the ESessionType enumeration type.

The Rescan All Managed Servers request now accepts the ManagedServersSpec schema in its request body, which allows you to rescan only the specified managed servers.

Breaking changes cause REST API to function differently and can affect the client code.

The required targetName property has been added to the FlrTaskItemModel object.

The required credentialsStorageType property has been added to the FUSELinuxMountSpec object.

• The storage property of the EntraIDAuditLogBackupJobSpec object is now required.
• The fileServerId property of the FileBackupJobObjectModel object is now required.
• The type and quantity properties of the FileBackupRetentionPolicySettingsModel object are now required.

• The subnet property of the AzureComputeNetworkModel and AzureInstantVMRecoveryApplianceModel objects is now required.
• The required include property has been added to the AzureComputeVMDiskConfigurationModel object. In addition, the diskUid property is now required.
• The overwrite property has been added to the EntireViVMRestoreSpec object.

The isTrusted required property has been added to the DiscoveredComputerEntityModel object.