This section describes changes introduced in Veeam Backup & Replication REST API 1.2-rev0.

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

The 1.2-rev0 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.2-rev0.

REST API 1.2-rev0 introduces new endpoints that allow you to protect your Entra ID environment.

Inventory Browser

The REST API now allows you to manage Microsoft Entra ID tenants.

Operations

• Get All Microsoft Entra ID Tenants
• Add Microsoft Entra ID Tenant
• Get Microsoft Entra ID Tenant
• Edit Microsoft Entra ID Tenant
• Remove Microsoft Entra ID Tenant

Restore

Now you can use REST API to restore Entra ID items and audit logs.

Operations

• Get User Code for Delegated Restore of Microsoft Entra ID Items
• Get Credentials for Delegated Restore of Microsoft Entra ID Items
• Mount Microsoft Entra ID Tenant
• Unmount Microsoft Entra ID Tenant
• Start Microsoft Entra ID Audit Log Restore
• Unmount Microsoft Entra ID Audit Logs

Jobs

The REST API now allows you to use existing job endpoints to create and manage Microsoft Entra ID backup jobs. When creating a job, specify one of the new job types, EntraIDTenantBackup or EntraIDAuditLogBackup, and the list of necessary properties.

Backup Browsers

In this version, the REST API has new endpoints that allow you to browse Microsoft Entra ID tenant backups, compare Microsoft Entra ID items, and restore entire items or their properties.

Operations

• Get Mount Points of All Entra ID Tenants
• Get Mount Point of Microsoft Entra ID Tenant
• Get Restore Points of Microsoft Entra ID Tenant
• Get Microsoft Entra ID Items
• Get Microsoft Entra ID Item
• Get Restore Points of Microsoft Entra ID Item
• Validate Microsoft Entra ID Items
• Check Microsoft Entra ID Items in Production
• Generate Microsoft Entra ID User Passwords
• Restore Microsoft Entra ID Items
• Restore Microsoft Entra ID Item Properties
• Compare Microsoft Entra ID Item Properties
• Start Comparing Microsoft Entra ID Item Properties
• Get Comparison Results for Microsoft Entra ID Items
• Export Microsoft Entra ID items
• Upload Microsoft Entra ID Users
• Upload Microsoft Entra ID Groups
• Upload Microsoft Entra ID Administrative Units
• Upload Microsoft Entra ID Roles
• Upload Microsoft Entra ID Applications
• Get All Restore Sessions of Microsoft Entra ID Tenant
• Get Restore Session of Microsoft Entra ID Tenant
• Get Restore Session Logs of Microsoft Entra ID Tenant
• Stop Restore Session of Microsoft Entra ID Tenant

REST API 1.2-rev0 supports all license management operations. You can use the REST API to install, renew and remove licenses from backup servers, revoke licenses from protected workloads or licensed hosts, and assign product editions to standalone Veeam agents.

Operations

• Install License
• Get Installed License
• Remove License
• Create License Usage Report
• Renew Installed License
• Get Consumption of Socket Licenses
• Revoke Socket License
• Get Instance Licenses Consumption
• Assign Instance License
• Revoke Instance License
• Get Capacity License Consumption
• Revoke Capacity License From Unstructured Data Workload
• Update License
• Enable or Disable License Auto Update
• Enable or Disable Instance Consumption for Unlicensed Agents

The REST API now also allows you to manage unstructured data servers.

Operations

• Get All Unstructured Data Servers
• Get Unstructured Data Servers

In this version, the REST API has new endpoints that allow you to perform the following operations with unstructured data.

Operations

• Get All Unstructured Data Mount Points
• Get Unstructured Data Mount Point
• Browse Unstructured Data File System
• Search for Files and Folders in Unstructured Data Source
• Browse Search Results
• Copy Files and Folders to Specific Folder

To get backup files use the following requests.

Operations

• Get All Backup Files
• Get Backup File

REST API 1.2-rev0 allows you to publish disks from backups and snapshot replicas and manage disk publishing sessions.

Operations

• Get All Disk Publishing Mount Points
• Start Disk Publishing
• Get Disk Publishing Mount Point
• Stop Disk Publishing

In this version, the REST API supports quick backup tasks, which allow you to create on-demand incremental backups for VMware vSphere and VMware Cloud Director VMs.

Operations

• Start Quick Backup

REST API 1.2-rev0 allows you to run the Security & Compliance Analyzer and ensure that your backup server configuration follows security best practices. New endpoints also allow you to get security-related events on the backup server.

Operations

• Start Security & Compliance Analyzer
• Get Security & Compliance Analyzer Last Run
• Get Security & Compliance Analyzer Schedule
• Modify Security & Compliance Analyzer Schedule
• Reset All Security & Compliance Analyzer Statuses
• Get Security & Compliance Analyzer Results
• Suppress Security & Compliance Analyzer Best Practice Status
• Reset Security & Compliance Analyzer Status
• Get All Authorization Events
• Get Authorization Event

In this version, the REST API allows you to monitor task sessions.

Operations

• Get Task Sessions For Specified Session
• Get All Task Sessions
• Get Task Session
• Get Task Session Logs

Now you can use the REST API to scan backup data with third-party antivirus engines or with YARA rules.

Operations

• Get YARA Rules
• Scan Backups with Antivirus or YARA Rules

The following minor non-breaking changes are introduced in REST API 1.2-rev0.

The EPlatformType enumeration type now includes the following platform types:

• EntraID
• Test

This change affects the platformNameFilter parameter in the Get All Backup Objects, Get All Restore Points and Get All Replica Restore Points requests, as well as the following objects: SessionModel, InventoryObjectModel, BackupModel, BackupObjectModel, ObjectRestorePointModel, ReplicaPointModel, BackupObjectsFilters, ObjectRestorePointsFilters and ReplicaRestorePointsFilters.

The syslogEventFiltering property is added to the GeneralOptionsSiemIntegrationModel object. It contains an array of objects GeneralOptionsSyslogEventFilteringModel, each containing an event ID eventID and an array of event severity levels severity which prevent Veeam Backup & Replication from sending events of the specified severity level to the syslog server.

The IndicatorOfCompromise property is added to the ESuspiciousActivityType object.

The Get All Repository States request now has the isOnlineFilter parameter that allows you filter repositories by their connection status.

The EJobType enumeration type now includes the FileBackupCopy job type.

Points

The type containing the ERestorePointType enumeration type, sessionId, backupFileId properties were added to the ObjectRestorePointModel object.

Restore

The destination property in the InstantViVMCustomizedRecoverySpec object is no longer required. If you do not specify this property, Veeam Backup & Replication recovers the VM to the original location.

The ESessionType enumeration type now includes the following new session types:

• PublishBackupContentViaMount
• EntraIdRestore
• BackupCopyJob
• SecurityComplianceAnalyzer
• FileServerSave
• SureBackup
• NasRestore
• UnstructuredDataBrowse

Now, when importing cloud credentials, the credentials property is not required.

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

The NasBackup platform type in the EPlatformType enumeration type is renamed to UnstructuredData.

This change affects the platformNameFilter parameter in the Get All Backup Objects, Get All Restore Points and Get All Replica Restore Points requests, as well as the following objects: SessionModel, InventoryObjectModel, BackupModel, BackupObjectModel, ObjectRestorePointModel, ReplicaPointModel, BackupObjectsFilters, ObjectRestorePointsFilters and ReplicaRestorePointsFilters.

The isOnline property is added to the RepositoryStateModel object. The property is required.

The gracefullStop property of JobStopSpec object is renamed to gracefulStop.

The platformName property of the ObjectRestorePointModel model is now required.

The platformName property of the ReplicaPointModel model is now required.

The viCredentials property of the CloudDirectorViHostImportSpec object is now required.