- About Veeam Backup & Replication REST API
- Overview
- How To
- Changelog
- Global Changes
- New Features
- Users and Roles
- Malware Detection
- High Availability Cluster
- Bare Metal Recovery and Volume Restore
- Backup Move and Copy
- Unstructured Data
- Microsoft Entra ID
- Deduplication Appliance Repositories
- Veeam Data Cloud Vault Archive
- Instant Recovery to Microsoft Azure
- Instant Recovery to Another Platform
- Quick Backup
- Proxmox VE and Nutanix AHV
- General Options
- Inventory Browser
- Agent Management
- Backup Browser
- Application Items Restore
- Deprecated Requests
- Minor Non-Breaking Changes
- Breaking Changes
- Login
- Service
- Services
- Credentials
- getGet All Credentials
- postAdd Credentials Record
- getGet Credentials Record
- putEdit Credentials Record
- delRemove Credentials Record
- postChange Password
- postChange Linux Private Key
- postChange Linux Root Password
- getGet All Cloud Credentials
- postAdd Cloud Credentials Record
- postGet Microsoft Entra ID Verification Code
- postRegister Microsoft Entra ID Application
- postGet Google Authentication Information
- getGet Cloud Credentials Record
- putEdit Cloud Credentials Record
- delRemove Cloud Credentials Record
- postChange Secret Key
- postChange Google Service Account
- postChange Certificate
- getGet All Helper Appliances
- postAdd or Edit Helper Appliance
- getGet Helper Appliance
- delRemove Helper Appliance
- Encryption
- getGet All Encryption Passwords
- postAdd Encryption Password
- getGet Encryption Password
- putEdit Encryption Password Hint
- delRemove Encryption Password
- postChange Encryption Password
- postVerify Encryption Password
- getGet All KMS Servers
- postAdd KMS Server
- getGet KMS Server
- putEdit KMS Server
- delRemove KMS Server
- postChange KMS Server Certificate
- License
- postInstall License
- getGet Installed License
- postRemove License
- postCreate License Usage Report
- postRenew Installed License
- getGet Consumption of Socket Licenses
- postRevoke Socket License
- getGet Instance Licenses Consumption
- postAssign Instance License
- postRevoke Instance License
- postRemove Instance License
- getGet Capacity License Consumption
- postRevoke Capacity License from Unstructured Data Workload
- postUpdate License
- postEnable or Disable License Auto Update
- postEnable or Disable Instance Consumption for Unlicensed Agents
- Connection
- Cloud Browser
- Inventory Browser
- getGet All VMware vSphere Servers
- getGet VMware vSphere Server Objects
- postRescan Inventory Objects
- postGet All Servers
- postGet Inventory Objects
- postGet Inventory Object Details
- postGet All Protection Groups
- postGet All Physical Inventory
- postGet Inventory Objects for Specific Protection Group
- getGet All Unstructured Data Servers
- postAdd Unstructured Data Servers
- getGet Unstructured Data Server Defaults
- getGet Unstructured Data Server
- putEdit Unstructured Data Server
- delRemove Unstructured Data Server
- postStart Browsing Unstructured Data Server
- postBrowse Unstructured Data Server
- postStop Browsing Unstructured Data Server
- getGet All Unstructured Data Server Inventory Browse Sessions
- getGet Unstructured Data Server Inventory Browse Session
- getGet All Microsoft Entra ID Tenants
- postAdd Microsoft Entra ID Tenant
- getGet Microsoft Entra ID Tenant
- putEdit Microsoft Entra ID Tenant
- delRemove Microsoft Entra ID Tenant
- getGet Active Directory Objects from Domain
- getGet Available Disk Slots for Platform
- Traffic Rules
- General Options
- getGet General Options
- putEdit General Options
- getGet Email Settings
- putEdit Email Settings
- postSend Test Email
- postCheck SMTP Server Certificate
- getGet Host Authentication Settings
- putEdit Host Authentication Settings
- postExport Trusted Hosts List to a File
- postImport Trusted Hosts List from a File
- getGet Notification Settings
- putEdit Notification Settings
- getGet Event Forwarding Settings
- putEdit Event Forwarding Settings
- getGet Storage Latency Settings
- putEdit Storage Latency Settings
- postAdd Latency Settings for Specific Datastore
- getGet Latency Settings for Specific Datastore
- putEdit Latency Settings for Specific Datastore
- delRemove Latency Settings for Specific Datastore
- getGet VSA Event Forwarding Settings
- putEdit VSA Event Forwarding Settings
- getGet Daemon Settings for VSA Event Forwarding
- putEdit Daemon Settings for VSA Event Forwarding
- getGet Node Exporter Settings
- putUpdate Node Exporter Settings
- postSet Node Exporter Basic Authentication
- Users and Roles
- getGet All Users and Groups
- postAdd User or Group
- getGet User or Group
- delRemove User or Group
- getGet Roles Assigned to User or Group
- putEdit Roles Assigned to User or Group
- postChange Service Account Mode
- postReset MFA for Specific User
- getGet All Roles
- postCreate Custom Role
- getGet Role
- putEdit Custom Role
- delDelete Custom Role
- getGet Role Permissions
- getGet Custom Role Details
- postClone Custom Role
- getGet MFA Settings
- putEdit MFA Settings
- getGet All Restore Options
- ACL
- Global Exclusions
- Security
- postStart Security & Compliance Analyzer
- getGet Security & Compliance Analyzer Last Run
- getGet Security & Compliance Analyzer Schedule
- putModify Security & Compliance Analyzer Schedule
- postReset All Security & Compliance Analyzer Statuses
- getGet Security & Compliance Analyzer Results
- postSuppress Security & Compliance Analyzer Best Practice Status
- postReset Security & Compliance Analyzer Status
- getGet All Authorization Events
- getGet Authorization Event
- Malware Detection
- getGet All Malware Events
- postCreate Malware Event
- getGet Malware Event
- getGet All Malware Detection Settings
- putEdit Malware Detection Settings
- getGet Malware Suspicious File Masks Settings
- putEdit Malware Suspicious File Masks Settings
- getGet Malware Allowed Trusted Extensions
- getGet Malware File Detection Indicators of Compromise
- postEnable Monitoring of Indicators of Compromise
- postDisable Monitoring of Indicators of Compromise
- getGet Logs for SureBackup Scan Task Session
- postMark Backup Objects as Clean
- getGet All Malware Detection Objects
- getGet Malware Detection Object
- getGet All Malware Detection Exclusions
- postCreate or Update Malware Detection Exclusions
- postDelete Malware Detection Exclusions
- getGet YARA Rules
- postScan Backups with Antivirus or YARA Rules
- postStart Malware Encryption Analysis
- getDownload Malware Encryption Analysis Logs
- Configuration Backup
- Deployment
- Managed Servers
- getGet All Servers
- postAdd Server
- postGet vCenter Servers Attached to Cloud Director Server
- postGet Microsoft Hyper-V Servers Managed by Microsoft Hyper-V Cluster or SCVMM Server
- getGet Server
- putEdit Server
- delRemove Server
- postChange to Single-Use Credentials
- getGet Volumes for Microsoft Hyper-V Standalone Server
- putEdit Volumes on Microsoft Hyper-V Standalone Server
- postRescan All Managed Servers
- postRescan Managed Server
- getDefault Set of Optional Managed Server Components
- postUpdate Managed Server Components
- Repositories
- getGet All Repositories
- postAdd Repository
- postRescan Repositories
- getGet All Repository States
- getGet Repository
- putEdit Repository
- delRemove Repository
- getGet Repository Access Permissions
- putEdit Repository Access Permissions
- getGet All Scale-Out Backup Repositories
- postAdd Scale-Out Backup Repository
- getGet Scale-Out Backup Repository
- putEdit Scale-Out Backup Repository
- delRemove Scale-Out Backup Repository
- postEnable Sealed Mode
- postDisable Sealed Mode
- postEnable Maintenance Mode
- postDisable Maintenance Mode
- Mount Servers
- Proxies
- WAN Accelerators
- Helper Appliance Templates
- High Availability (HA) Cluster
- Jobs
- getGet All Jobs
- postCreate Job
- getGet All Job States
- getGet Job
- putEdit Job
- delDelete Job
- postStart Job
- postStop Job
- postRetry Job
- postDisable Job
- postEnable Job
- postApply Backup Policy Configuration
- postClear Backup Cache
- postClone Job
- postStart Quick Backup for VMware vSphere or VMware Cloud Director VM
- postStart Quick Backup for Hyper-V VM
- postStart Quick Backup for Agent-Managed Machine
- Backups
- getGet All Backups
- getGet Backup
- delDelete Backup
- postView Backup Details
- getGet Backup Objects
- delDelete Backup Object
- postDownload Backup Metadata
- getGet All Backup Files
- getGet Backup File
- postMark Backup File as Clean
- postMark Backup File as Infected
- postRun Health Check and Repair
- postCopy Backups to Another Repository
- postCopy Machine Backups to Another Repository or Folder
- postMove Backup to Another Repository
- postMove Backup Objects to Another Job
- getGet Move/Copy Backup Sessions Awaiting Action
- postManage a Move/Copy Backup Session Awaiting Action
- Backup Objects
- Restore Points
- Restore
- postRestore Entire File Share
- postRestore Entire Object Storage Bucket or Container
- getGet All Mount Points for Instant File Share Recovery
- postStart Instant File Share Recovery
- getGet Mount Point for Instant File Share Recovery
- postStop File Share Publishing
- postStart File Share Migration
- postStart File Share Switchover
- getGet File Share Switchover Settings
- putUpdate File Share Switchover Settings
- postStart File Restore from Unstructured Data Backup
- postUnmount Unstructured Data FLR Volumes
- postProlong a Retrieval Operation from Cold Object Storage
- getGet Cold Object Storage Retrieval Operations
- getGet All Mount Points for Instant Recovery to VMware vSphere
- postStart Instant Recovery to VMware vSphere
- getGet Mount Point for Instant Recovery to VMware vSphere
- postStop Publishing Machine to VMware vSphere
- postStart Migrating Machine to VMware vSphere
- getGet All Mount Points for Instant Recovery to Microsoft Hyper-V
- postStart Instant Recovery to Microsoft Hyper-V
- getGet Mount Point for Instant Recovery to Microsoft Hyper-V
- postStop Publishing Machine to Microsoft Hyper-V
- postStart Migrating Machine to Microsoft Hyper-V
- getGet All Mount Points for Instant Recovery to Microsoft Azure
- postStart Instant Recovery to Microsoft Azure
- getGet Mount Point for Instant Recovery to Microsoft Azure
- getGet All Mount Sessions for Instant Recovery to Microsoft Azure
- postStop Publishing Machine to Microsoft Azure
- postStart Migrating Machine to Microsoft Azure
- getGet Settings for Switchover to Microsoft Azure
- putUpdate Settings for Switchover to Microsoft Azure
- postStart Switchover to Microsoft Azure
- postRestore Entire VMware vSphere VM
- postRestore Entire VMware Cloud Director VM
- postRestore Entire Microsoft Hyper-V VM
- getGet All FCD Mount Points
- postStart Instant FCD Recovery
- getGet FCD Mount Point
- postStop FCD Publishing
- postStart FCD Migration
- postStart File Restore
- postUnmount File System
- postGet User Code for Delegated Restore of Microsoft Entra ID Items
- postGet Credentials for Delegated Restore of Microsoft Entra ID Items
- getGet Redirect URI for Delegated Restore of Microsoft Entra ID Items
- postPerform Authorization Code Exchange for Delegated Restore of Microsoft Entra ID Items
- postMount Microsoft Entra ID Tenant
- postStart Microsoft Entra ID Tenant Restore from Copy
- postUnmount Microsoft Entra ID Tenant
- postStart Microsoft Entra ID Audit Log Restore
- postUnmount Microsoft Entra ID Audit Logs
- postStarts Volume Restore for Agent or Recovery Appliance
- Application Items Restore
- DiskManagement
- postInitialize Disk Management
- postMap Backup Layout to Host Layout Automatically
- putKeep Disk Management Session Alive
- getGet Current Restore Layout of Host
- postApply Backup Layout
- postApply Disk Layout
- postErase Disk
- postRemove Partition
- postResize Partition
- postGet Partition Resize Options
- postRestore Partition
- putUnlock BitLocker-Protected Volume
- putCreate Disk Management Checkpoint
- putRevert to Disk Management Checkpoint
- Recovery Media
- Data Integration API
- Backup Browser
- postValidate Target Machine Credentials
- postValidate FLR Restore Item Target Path
- getGet All File Restore Mount Points
- getGet File Restore Mount Point
- getGet Restored Files Audit
- postBrowse File System
- postCompare Attributes
- postCompare Files and Folders
- postSearch for Files and Folders
- postBrowse Search Results
- postRestore Files and Folders to Original Location
- postRestore Files and Folders to Another Location
- postPrepare Files and Folders for Download
- postDownload Files and Folders
- getDownload Files and Folders
- getGet All Unstructured Data Mount Points
- getGet Unstructured Data Mount Point
- postBrowse Unstructured Data File System
- postGet Restore Points of Unstructured Data File System Item
- postSearch for Files and Folders in Unstructured Data Mount Point
- postBrowse Search Results in Unstructured Data Mount Point
- postCopy Files and Folders to Specific Folder
- postRestore Files and Folders from Unstructured Data Backup
- postPrepare Files and Folders for Download from Unstructured Data Backup
- getDownload Files and Folders
- postCompare Attributes of Unstructured Data Backup with Source
- postCompare Files and Folders of Unstructured Data Backup with Source
- getGet Mount Points of All Microsoft Entra ID Tenants
- getGet Mount Point of Microsoft Entra ID Tenant
- postGet Restore Points of Microsoft Entra ID Tenant
- getGet Protection Scope of Microsoft Entra ID Tenant
- postGet Microsoft Entra ID Items
- postGet Microsoft Entra ID Item
- postGet Restore Points of Microsoft Entra ID Item
- postValidate Microsoft Entra ID Items
- postCheck Microsoft Entra ID Items in Production
- postGenerate Microsoft Entra ID User Passwords
- postRestore Microsoft Entra ID Items
- postRestore Microsoft Entra ID Item Properties
- postCompare Microsoft Entra ID Item Properties
- postStart Comparing Microsoft Entra ID Item Properties
- getGet Comparison Results for Microsoft Entra ID Items
- postStart Comparing Microsoft Entra ID Conditional Access Policy
- getGet Comparison Results for Microsoft Entra ID Conditional Access Policy
- postStart Exporting Microsoft Entra ID Items to JSON
- getGet JSON Export Results for Microsoft Entra ID Items
- postExport Microsoft Entra ID Tenant Objects To JSON
- postExport Microsoft Entra ID Items
- postUpload Microsoft Entra ID Users
- postUpload Microsoft Entra ID Groups
- postUpload Microsoft Entra ID Administrative Units
- postUpload Microsoft Entra ID Roles
- postUpload Microsoft Entra ID Applications
- postUpload Microsoft Entra ID Conditional Access Policies
- postUpload Microsoft Entra ID Device Configurations
- postUpload Microsoft Entra ID Organization Contacts
- postUpload Microsoft Entra ID Devices
- getGet All Restore Sessions of Microsoft Entra ID Tenant
- getGet Restore Session of Microsoft Entra ID Tenant
- getGet Restore Session Logs of Microsoft Entra ID Tenant
- postStop Restore Session of Microsoft Entra ID Tenant
- postReveal Microsoft Entra ID BitLocker Recovery Key
- Tasks
- Replicas
- Replica Restore Points
- Failover
- Failback
- Sessions
- Agents
- getGet All Recovery Tokens
- postCreate Recovery Token
- getGet Recovery Token
- putEdit Recovery Token
- delDelete Recovery Token
- getGet All Protected Linux Computers
- getGet Protected Linux Computer
- getGet All Discovered Entities
- getGet All Agent States
- getGet Agent State
- getGet Agent Backups
- postAttach Backups to Agent
- postDetach Backups from Agent
- getGet Protection Groups
- postAdd Protection Group
- getGet Protection Group
- putEdit Protection Group
- delRemove Protection Group
- postRescan Protection Group
- postEnable Protection Group
- postDisable Protection Group
- postDownload Protection Group Packages
- getGet Discovered Entities
- postRescan Discovered Entities
- postReboot Discovered Entities
- postInstall Agent on Discovered Entities
- postUninstall Agent from Discovered Entities
- postUpgrade Agent on Discovered Entities
- postInstall CBT Driver on Discovered Entities
- postUninstall CBT Driver from Discovered Entities
- postUninstall All Components from Discovered Entities
- postAdd Discovered Entities to Trusted Hosts List
- postPrepare Agent Hosts for Remote Bare Metal Recovery
- postRecreate Embedded Recovery Media on Agent Hosts
- getGet Discovered Entity
- delRemove Discovered Entity
- postCreate Recovery Media Task for Discovered Entity
- getCreate Recovery Media for Discovered Entity
- getGet Linux Agent Packages
- getGet Unix Agent Packages
- getGet Agents Recovery Appliances
- getGet Agents Recovery Appliance
- postReboots Agents Recovery Appliances
- postReboots Agents Recovery Appliance
- Active Directory Domains
- Automation
- postImport Jobs
- postExport Jobs
- postImport Credentials
- postExport Credentials
- postImport Cloud Credentials
- postExport Cloud Credentials
- postImport Proxies
- postExport Proxies
- postImport Servers
- postExport Servers
- postImport Repositories
- postExport Repositories
- postImport Encryption Passwords
- postExport Encryption Passwords
- getGet All Automation Sessions
- getGet Automation Session
- getGet Automation Session Logs
- postStop Automation Session
- Log export
This section describes changes introduced in Veeam Backup & Replication REST API 1.3-rev2.
To use the latest revision of the REST API, specify the 1.3-rev2 value in the x-api-version header of each request. For details on REST API versions, see Versioning.
The 1.3-rev2 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.
This revision continues progress toward full REST API coverage with additions across role-based access control, malware detection, high availability, bare metal recovery, deduplication appliance repositories, unstructured data protection and backup operations.
The following new features are introduced in Veeam Backup & Replication REST API 1.3-rev2.
REST API 1.3-rev2 completes the role-based access control coverage. You can now create and modify custom roles, define their scope with access control lists (ACLs), and manage access permissions of backup repositories.
New Operations
Users and Roles
- Create Custom Role
- Edit Custom Role
- Delete Custom Role
- Get Custom Role Details
- Clone Custom Role
- Get All Restore Options
ACL
- Get Access Control List
- Get ACL Record
- Change Owner of ACL Record
- Change Effective Access of ACL Record
Repositories
Updated Schema
- The
CustomRoleSpecandCustomRoleModelobjects have been added. They define the scope of a custom role with theinventoryScope,repositoryScope,restorePermissionsScopeandrestoreTargetScopeproperties. - The
permissionScopeparameter has been added to the Get All VMware vSphere Servers, Get VMware vSphere Server Objects, Get Protection Groups, Get Protection Group, Get Discovered Entities and Get Discovered Entity requests. The parameter allows you to return only the inventory objects that are valid under the specified permission scope. - The
isBuiltInFilterparameter has been added to the Get All Roles request, which allows you to return either built-in or custom roles only. - The
isBuiltInproperty has been added to theRoleModelobject. - The
aclInfoproperty has been added to theVmwareObjectModel,HyperVObjectModelandAgentObjectModelobjects. The property contains the owner of the object and the effective access permissions.
Malware detection settings, exclusions, indicators of compromise and encryption analysis are now fully accessible via REST API. For details on the malware detection workflow, see Malware Detection.
New Operations
Malware Detection
- Get All Malware Detection Settings
- Edit Malware Detection Settings
- Get Malware Suspicious File Masks Settings
- Edit Malware Suspicious File Masks Settings
- Get Malware Allowed Trusted Extensions
- Get Malware File Detection Indicators of Compromise
- Enable Monitoring of Indicators of Compromise
- Disable Monitoring of Indicators of Compromise
- Get All Malware Detection Objects
- Get Malware Detection Object
- Get All Malware Detection Exclusions
- Create or Update Malware Detection Exclusions
- Delete Malware Detection Exclusions
- Start Malware Encryption Analysis
- Download Malware Encryption Analysis Logs
Backups
Updated Schema
The
MalwareBackupScanBaseSpecbase object has been added. The Scan Backups with Antivirus or YARA Rules request now accepts this object, which has the following child schemas:MalwareBackupScanSpecMalwareScanUnstructuredBackupSpec
For more information, see Breaking Changes.
The
restorePointIdproperty has been added to theMalwareBackupScanSpecobject.The
Specifictype has been added to theEMalwareBackupScanModeenumeration type.The
severityproperty has been added to theBackupFileModelobject.The
reasonproperty of theBackupObjectMarkAsCleanSpecobject is no longer required.The
EncryptionAnalysistype has been added to theESessionTypeenumeration type.
Cluster management, failover and switchover are now available via REST API for automation of high availability workflows.
New Operations
- Get High Availability Cluster
- Create High Availability Cluster
- Edit High Availability Cluster Settings
- Delete High Availability Cluster
- Start High Availability Cluster Switchover
- Start High Availability Cluster Failover
Updated Schema
- The
HaSwitchoverandHaClusterEdittypes have been added to theESessionTypeenumeration type.
REST API 1.3-rev2 introduces new endpoints that allow you to create and download recovery media, manage disks and volumes of a target host, and restore volumes to Veeam Agent computers and recovery appliances. For details on the restore workflow, see Bare Metal Recovery and Volume Restore.
New Operations
DiskManagement
- Initialize Disk Management
- Get Current Restore Layout of Host
- Map Backup Layout to Host Layout Automatically
- Apply Backup Layout
- Apply Disk Layout
- Erase Disk
- Remove Partition
- Resize Partition
- Get Partition Resize Options
- Restore Partition
- Unlock BitLocker-Protected Volume
- Create Disk Management Checkpoint
- Revert to Disk Management Checkpoint
- Keep Disk Management Session Alive
Restore
Recovery Media
Backup Objects
Agents
- Create Recovery Media Task for Discovered Entity
- Recreate Embedded Recovery Media on Agent Hosts
- Prepare Agent Hosts for Remote Bare Metal Recovery
- Reboot Discovered Entities
- Get Agents Recovery Appliances
- Get Agents Recovery Appliance
- Reboots Agents Recovery Appliances
- Reboots Agents Recovery Appliance
Inventory Browser
Restore Points
Updated Schema
- The
RecoveryMediatype has been added to theETaskTypeenumeration type, and theTaskModelobject now has theRecoveryMediaTaskModelchild schema. - The
ObjectRestorePointDiskModelobject has been updated with the following child schemas:WindowsPhysicalObjectRestorePointDiskModelLinuxPhysicalObjectRestorePointDiskModelCustomPlatformObjectRestorePointDiskModel
- The
createEmbeddedRecoveryMediaproperty has been added to theProtectionGroupAdvancedWindowsSettingsModelobject. - The
embeddedRecoveryMediaStateproperty has been added to theDiscoveredComputerEntityModelobject. - The following types have been added to the
ESessionTypeenumeration type:AgentsRecoveryAppliancesManagementRestoreAgentVolumesRestoreRecoveryApplianceVolumesInstantDiskRecoveryDiskRestore
REST API 1.3-rev2 allows you to move backups and backup objects to another location, view detailed information about a backup, and manage move and copy sessions that require user action.
New Operations
- View Backup Details
- Copy Machine Backups to Another Repository or Folder
- Copy Backups to Another Repository
- Move Backup to Another Repository
- Move Backup Objects to Another Job
- Get Move/Copy Backup Sessions Awaiting Action
- Manage a Move/Copy Backup Session Awaiting Action
Note that the POST /api/v1/backups/copyTo request has been removed — for more information, see Breaking Changes.
Updated Schema
- The
backupIdandsizeproperties have been added to theBackupObjectModelobject. - The
ActionRequiredtype has been added to theESessionStateenumeration type. - The
PerVmMoveBackupandPerVmCopyBackuptypes have been added to theESessionTypeenumeration type.
REST API 1.3-rev2 extends unstructured data protection with browsing of unstructured data servers, retrieval of data from cold object storage, and download of files and folders from unstructured data backups.
New Operations
Inventory Browser
- Get Unstructured Data Server Defaults
- Start Browsing Unstructured Data Server
- Browse Unstructured Data Server
- Stop Browsing Unstructured Data Server
- Get All Unstructured Data Server Inventory Browse Sessions
- Get Unstructured Data Server Inventory Browse Session
Backup Browser
- Get Restore Points of Unstructured Data File System Item
- Prepare Files and Folders for Download from Unstructured Data Backup
- Download Files and Folders
Restore
Updated Schema
- The
coldStorageRetrievalSettingsproperty has been added to theUnstructuredDataMountSpec,UnstructuredDataShareRestoreOptionsModel,UnstructuredDataOSRestoreOptionsModel,UnstructuredDataFLRItemRestoreSpec,FileBackupFLRCopyToSpec,UnstructuredBackupDownloadMetaSpec,CopyBackupSpec,HealthCheckRepairOptionsandEntraIdTenantStartRestoreFromCopySpecobjects. The property defines how Veeam Backup & Replication retrieves data from cold object storage. - The
coldStorageRetrievalModeparameter has been added to the Edit Unstructured Data Server request. - The
AzureDataLake,SANSMBShareandSANNFSSharetypes have been added to theEUnstructuredDataServerTypeenumeration type, and to theUnstructuredDataServerModelandUnstructuredDataServerSpecobjects as child schemas. - The
hostTypeproperty has been added to theFileServerModelobject. - The
symbolicLinksproperty has been added to theFileBackupJobAdvancedSettingsModelobject. - The
UnstructuredBackupJobObjectModelbase object has been added. TheFileBackupJobObjectModelandObjectStorageBackupJobObjectModelobjects are now its child schemas, and theGenericUnstructuredBackupJobObjectModelchild schema has been added — for more information, see Breaking Changes. - The
unstructuredLinkedJobsproperty has been added to theSureBackupContentScanJobModelandSureBackupContentScanJobSpecobjects. - The
FileBackupArchiveRetrievalProlongingtype has been added to theESessionTypeenumeration type.
REST API 1.3-rev2 allows you to back up and restore Microsoft Entra ID devices and organization contacts, export Microsoft Entra ID items to JSON, and reveal BitLocker recovery keys.
New Operations
- Start Exporting Microsoft Entra ID Items to JSON
- Get JSON Export Results for Microsoft Entra ID Items
- Export Microsoft Entra ID Tenant Objects To JSON
- Upload Microsoft Entra ID Devices
- Upload Microsoft Entra ID Organization Contacts
- Reveal Microsoft Entra ID BitLocker Recovery Key
Updated Schema
- The
EntraIdTenantBrowseModelobject has been updated with theEntraIdTenantDeviceBrowseModelandEntraIdTenantOrgContactBrowseModelchild schemas. - The
EntraIdTenantBrowseSpecobject has been updated with theEntraIdTenantDeviceBrowseSpecandEntraIdTenantOrgContactBrowseSpecchild schemas. - The
DeviceandOrgContacttypes have been added to theEEntraIdTenantItemTypeenumeration type. - The
DevicesandOrgContactstypes have been added to theEEntraIdTenantResourceenumeration type. - The
applicationCertificatesandreferenceRestoreModeproperties have been added to theEntraIdTenantItemRestoreSpecobject. - The
referenceRestoreModeproperty has been added to theEntraIdTenantRestoreItemAttributesSpecobject. - The
referencesproperty has been added to theEntraIdTenantItemRecursiveComparisonModelobject. - The
credentialsTypeandnameproperties have been added to theEntraIDTenantModelobject. - The
odataTypeproperty has been added to theEntraIdTenantDeviceConfigurationBrowseModelandEntraIdTenantDeviceConfigurationFilterBrowseSpecobjects, and thedeviceConfigurationTypeproperty has been added to theEntraIdTenantDeviceConfigurationBrowseModelobject. - The
OdataTypetype has been added to theEEntraIdTenantDeviceConfigurationSortingPropertyenumeration type.
Deduplication appliance repositories (Dell Data Domain, HPE StoreOnce, ExaGrid, Quantum DXi, Infinidat InfiniGuard and Fujitsu ETERNUS CS800) can now be added, configured and managed via REST API.
Updated Schema
- The
RepositoryModelobject has been updated with the following child schemas:DellDataDomainStorageModelHPEStoreOnceStorageModelExaGridStorageModelQuantumDXiStorageModelInfinidatStorageModelFujitsuStorageModel
- The
RepositorySpecobject has been updated with the following child schemas:DellDataDomainStorageSpecHPEStoreOnceStorageSpecExaGridStorageSpecQuantumDXiStorageSpecInfinidatStorageSpecFujitsuStorageSpec
- The
DDBoost,HPStoreOnceIntegrationandQuantumtypes of theERepositoryTypeenumeration type have been renamed toDellDataDomain,HPEStoreOnceandQuantumDXi— for more information, see Breaking Changes. - The
skipDedupAppliancesparameter has been added to the Get All Servers request, which allows you to exclude Linux-based deduplication storage appliance hosts from the list.
REST API 1.3-rev2 allows you to add and browse Veeam Data Cloud Vault Archive object storage.
Updated Schema
- The
VeeamDataCloudVaultArchivetype has been added to theERepositoryTypeenumeration type, and theVeeamDataCloudVaultArchiveStorageModelandVeeamDataCloudVaultArchiveStorageSpecchild schemas have been added to theRepositoryModelandRepositorySpecobjects. - The
VeeamDataCloudVaultArchivetype has been added to theECloudServiceTypeenumeration type, and to theCloudBrowserModel,CloudBrowserSpecandCloudBrowserNewFolderSpecobjects as a child schema. - The
regionIdproperty has been added to theVeeamDataCloudVaultModelobject.
Helper appliance templates that assist with facilitating instant recovery to Microsoft Azure can now be fully managed via REST API.
New Operations
- Get All Helper Appliance Templates
- Deploy Helper Appliance Templates
- Get Helper Appliance Template
- Get Helper Appliance Template State
- Remove Helper Appliance Templates
Updated Schema
- The
AzureComputeNetworkSecurityGroupModelobject has been added. ThenetworkSecurityGrouprequired property has been added to theAzureComputeNetworkModelobject — for more information, see Breaking Changes.
Scripted Instant Recovery from any image-level backup source to VMware vSphere or Hyper-V can now be initiated and managed via REST API.
Updated Schema
- The
OtherPlatformtype has been added to theEInstantVMRecoveryModeTypeenumeration type. - The
InstantViVMRecoverySpecobject has been updated with theInstantViVMOtherPlatformRecoverySpecchild schema. - The
InstantHvVMRecoverySpecobject has been updated with theInstantHvVMOtherPlatformRecoverySpecchild schema. - The
shareCredentialsIdproperty has been added to theInstantViVMRecoverySpecandInstantHvVMRecoverySpecobjects. - The
helperApplianceandenableClusterWideMountproperties have been added to theInstantViVMCustomizedRecoveryDestinationSpecobject.
Ad-hoc quick backup sessions can be triggered via REST API for Hyper-V VMs and Veeam Agent managed machines.
New Operations
Updated Schema
- The
AgentOperationBackupNow,AgentOperationActiveFullandEpAgentOperationStopBackuptypes have been added to theESessionTypeenumeration type.
REST API 1.3-rev2 allows you to query the Proxmox VE and Nutanix AHV infrastructure, get backups, restore points and sessions, and start and stop jobs by using the existing endpoints.
Updated Schema
- The
NutanixAHVBackupJobandProxmoxBackupJobtypes have been added to theEJobTypeenumeration type. - The
NutanixandProxmoxtypes have been added to theEInventoryPlatformTypeandEPlatformTypeenumeration types. - The
InventoryObjectModelobject has been updated with theNutanixObjectModelandProxmoxObjectModelchild schemas. - The
BackupObjectModelobject has been updated with theNutanixBackupObjectModelandProxmoxBackupObjectModelchild schemas. - The
NutanixCluster,PrismCentral,ProxmoxNodeandProxmoxClustertypes have been added to theEManagedServerTypeenumeration type. - The
NutanixAHVandPVEtypes have been added to theEProxyTypeenumeration type. - The
PlatformServiceJob,PlatformBackupJob,PlatformSnapshotJobandPlatformSnapshotCopyJobtypes have been added to theESessionTypeenumeration type.
REST API 1.3-rev2 allows you to manage host authentication, VSA event forwarding and Node Exporter settings, and to check the certificate of an SMTP server.
New Operations
- Check SMTP Server Certificate
- Get Host Authentication Settings
- Edit Host Authentication Settings
- Export Trusted Hosts List to a File
- Import Trusted Hosts List from a File
- Get VSA Event Forwarding Settings
- Edit VSA Event Forwarding Settings
- Get Daemon Settings for VSA Event Forwarding
- Edit Daemon Settings for VSA Event Forwarding
- Get Node Exporter Settings
- Update Node Exporter Settings
- Set Node Exporter Basic Authentication
Updated Schema
- The
thumbprintsproperty has been added to theAdvancedSmtpOptionsModelobject.
REST API 1.3-rev2 allows you to get the physical infrastructure inventory and detailed information about inventory objects.
New Operations
Updated Schema
- The
powerStateproperty has been added to theVmwareObjectModelobject. - The
Customtype has been added to theEAgentInventoryObjectTypeenumeration type.
REST API 1.3-rev2 allows you to get the state of Veeam Agents installed on discovered entities, and to attach backups to an agent or detach them from it.
New Operations
REST API 1.3-rev2 introduces the following requests:
- Download Files and Folders — allows you to download files and folders that have been prepared for download.
- Validate FLR Restore Item Target Path — allows you to check whether the specified target path is valid before you restore files and folders.
REST API 1.3-rev2 introduces the Get All Child Restore Sessions for Application Item Browse Session request. It allows you to get all restore sessions that are performed within an application item browse session.
The following requests are deprecated in REST API 1.3-rev2:
The following minor non-breaking changes are introduced in REST API 1.3-rev2.
- The
connectionTypeandsingleUseCredentialsproperties have been added to theADObjectCustomCredentialsModelobject. - The
groupScopeproperty has been added to theADObjectModelobject. - The
installNoSnapAgentproperty has been added to theProtectionGroupOptionsModelobject. - The
InstalledRebootRequiredandNotInstalledRebootRequiredtypes have been added to theEDriverStatusenumeration type. - The
PPC64letype has been added to theEOSBitnessandEOperatingSystemPlatformenumeration types. - The
masterCredentialsIdproperty of theADObjectsProtectionGroupCredentialModelobject is no longer required. - The
isDisabledproperty of theProtectionGroupModelobject is no longer required.
The Get All Backups request now accepts the policyUniqueIdFilter parameter, which allows you to filter backups by the unique ID of the retention policy.
- The Get Restore Points request now accepts the
typeFilterandexcludeSnapshotTypeFilterparameters, which allow you to filter restore points by their type and to exclude restore points with the specified snapshot types. - The
gfsPeriods,snapshotTypeandtagproperties have been added to theObjectRestorePointModelobject. - The
StartDiskPublishtype has been added to theEObjectRestorePointOperationenumeration type.
- The Backup Browsers tag has been renamed to Backup Browser.
- The
credentialsIdproperty has been added to theFlrRestoreCredentialsValidationResultobject. - The
credentialsIdproperty of theFlrRestoreToSpecobject is no longer required.
- The
uniqueIdproperty has been moved to theCredentialsModel,CredentialsSpec,CloudCredentialsModelandCloudCredentialsSpecbase objects from their child schemas. - The
isDefaultApplianceproperty has been added to theCredentialsModelobject. - The
includeHiddenCredsproperty has been added to theCredentialsFiltersandCloudCredentialsFiltersobjects.
The includeWindowsPackages, includeLinuxPackages and includeUnixPackages properties have been added to the CreateDeploymentKitSpec object.
- The
aiPoweredReportEnabledproperty has been added to theGeneralOptionsEmailSettingsModelobject. - The
isDefaultAppproperty has been added to theGeneralOptionsGmailServerSettingsModelandGeneralOptionsMS365ServerSettingsModelobjects.
- The Get Active Directory Objects from Domain request now accepts the
parentIdFilterparameter, which allows you to return only direct children of the specified parent object. - The
regionDisplayNameproperty has been added to theAmazonS3ServerAccountModel,AzureBlobServerModelandS3CompatibleServerAccountModelobjects. - The
metadataproperty has been added to theCloudDirectorObjectModelobject. - The
TypeandRegiontypes have been added to theEUnstructuredDataServersFiltersOrderColumnenumeration type.
- The
backupCacheproperty has been added to theAgentBackupPolicyStorageLocalStorageModelandAgentBackupPolicyStorageSharedFolderModelobjects. - The
inlineDataDedupEnabledproperty has been added to theAgentBackupStorageSettingsModelandBackupCopyJobStorageSettingsModelobjects. - The
backupMonitoringproperty has been added to theAgentNotificationSettingsModelobject. - The
credentialsIdanduseGuestCredentialsproperties have been added to theWindowsAgentBackupScriptSettingsModelobject. - The
secondaryTargetsproperty has been added to theEntraIDAuditLogBackupJobModel,EntraIDAuditLogBackupJobSpec,FileBackupJobModel,FileBackupJobSpec,ObjectStorageBackupJobModelandObjectStorageBackupJobSpecobjects. - The
gfsPolicyproperty has been added to theFileBackupCopyJobModel,FileBackupCopyJobSpec,FileBackupJobPrimaryRepositoryModelandObjectStorageBackupJobPrimaryRepositoryModelobjects. - The
isDisabledproperty has been added to theEntraIDTenantBackupCopyJobSpecobject. - The
targetNameproperty has been added to theJobStateModelobject. - The
dailySummaryLocalTimeandsendDailySummaryproperties have been added to theEmailNotificationSettingsModelobject. - The
WindowsAgentBackupFailoverClustertype has been added to theEJobTypeenumeration type. - The
8MBtype has been added to theEStorageOptimizationenumeration type. - The
virtualMachinesproperty of theBackupJobModel,BackupJobSpec,HyperVBackupJobModel,HyperVBackupJobSpec,CloudDirectorBackupJobModelandCloudDirectorBackupJobSpecobjects is no longer required. - The
includesproperty of theBackupJobVirtualMachinesModel,BackupJobVirtualMachinesSpecandHyperVBackupJobVirtualMachinesModelobjects is no longer required. - The
disksproperty of theVmwareObjectDiskModelandHyperVObjectDiskModelobjects is no longer required. - The
backupRepositoryproperty of theFileBackupJobSpecandObjectStorageBackupJobSpecobjects is no longer required. - The
primaryJobIdproperty of theFileBackupCopyJobModelandFileBackupCopyJobSpecobjects is no longer required. - The
storageproperty of theEntraIDAuditLogBackupJobSpecobject is no longer required. - The
linkedJobsproperty of theSureBackupContentScanJobModelandSureBackupContentScanJobSpecobjects is no longer required. - The
useGuestCredentialsproperty of theAgentBackupOracleSettingsModelobject is no longer required. - The
isDisabledproperty of theJobModelobject is no longer required.
The following types have been added to the ELicensePlatformType enumeration type: UniversalCdpLinux, NdmpNetApp2Tape, AbrBackup, Scp, XcpNg, XenServer, HpeVme, Sfr, Kbv, Onl, Pl9, Vrg, Rho and Vtz.
- The
ApplicationBackupRepositorytype has been added to theEOptionalComponentTypeenumeration type. - The
OpenSSL312,OpenTelemetryCollectorandHotAddtypes have been added to theEHostComponentTypeenumeration type.
The Get All Replicas request now accepts the policyUniqueIdFilter parameter, which allows you to filter replicas by the unique ID of the retention policy.
- The
copyPolicyEnabled,movePolicyEnabled,encryptionandextentCryptoKeyIdproperties have been added to theArchiveTierModelobject. - The
cryptoKeyIdproperty has been added to theCapacityExtentModelobject. - The
enableGovernanceModeandgovernanceModeRetentionDaysproperties have been added to theLinuxLocalRepositorySettingsModelobject. - The
readOnlyFilterproperty has been added to theRepositoryStatesFiltersobject. - The
Statustype has been added to theERepositoryStatesFiltersOrderColumnenumeration type. - The
mountServerproperty of all repositoryModel,SpecandImportSpecobjects is no longer required. - The
VeeamDataCloudVaultAwsExternalandVeeamDataCloudVaultAzureExternaltypes have been added to theERepositoryTypeenumeration type.
- The
yaraRuleandyaraScanEnabledproperties have been added to theSecureRestoreSpecobject, and theantivirusScanEnabledproperty is no longer required. - The
defaultDatastoreproperty has been added to theRestoreTargetDatastoresSpecobject. - The
reasonproperty has been added to theVmwareFcdInstantRecoverySpecobject. - The
vmTagsRestoreEnabledproperty has been moved from theInstantViVMRecoverySpecobject to theInstantViVMCustomizedRecoverySpecandInstantViVMOriginalLocationRecoverySpecobjects. - The
ViVMQuickMigrationDatastoresSpecobject has been added, and thedestinationHostproperty of theViVMQuickMigrationSpecobject is no longer required. - The
ipAddressproperty of theIPv4SettingsModelandIPv6SettingsModelobjects is no longer required. - The
redirectEnabledproperty of theInstantViVMCustomizedRecoveryDatastoreSpecobject is no longer required.
- The Get All Restore Points request now accepts the
typeFilterandexcludeSnapshotTypeFilterparameters, which allow you to filter restore points by their type and to exclude restore points with the specified snapshot types. - The
capacityproperty of theObjectRestorePointDiskModelobject and thesizeproperty of theHyperVDiskExtentModelobject are no longer required.
- The
algorithm,originalSessionId,progressandretryInfoproperties have been added to theSessionModelobject. - The
platformIdandplatformTypeproperties have been added to theBackupTaskSessionModelobject. - The following types have been added to the
ESessionTypeenumeration type:AgentManagement,BackupCopyJobParent,ApplicationLevelRestore,VeeamUpdaterSettingsSync,EndpointBackup,EndpointRestore,StorageDiscovery,StorageMonitoring,AdForestRestore,BackupCacheSyncandIndexCollection. - The
LinuxPhysicalPpcandApplicationBackupRepositorytypes have been added to theEPlatformTypeenumeration type.
- The Get All Users and Groups request now accepts the
mfaEnabledFilterparameter, which allows you to filter users by the multi-factor authentication state. - The
MfaEnabledtype has been added to theEUserFiltersOrderColumnenumeration type.
Breaking changes cause REST API to function differently and can affect the client code.
The required masterConnectionType property has been added to the ADObjectsProtectionGroupCredentialModel object.
- The
POST /api/v1/backups/copyTorequest has been removed. Use the Copy Machine Backups to Another Repository or Folder or Copy Backups to Another Repository request instead. - The
objectIdproperty of theBackupFileModelobject has been replaced with the requiredobjectIdsproperty. - The
policyTagFilterparameter of the Get All Backups request has been replaced with thepolicyUniqueIdFilterparameter. ThepolicyTagFilterproperty of theBackupsFiltersobject has been replaced with thepolicyUniqueIdFilterproperty. - In the
BackupObjectModelobject, theEC2andGoogleCloudtypes have been renamed toAWSEC2andGCE.
- The
BitlockerKeyandDeviceCompliancePolicytypes have been removed from theEEntraIdTenantItemTypeenumeration type, and theEntraIdTenantBitlockerKeyBrowseModelandEntraIdTenantBitlockerKeyBrowseSpecchild schemas have been removed from theEntraIdTenantBrowseModelandEntraIdTenantBrowseSpecobjects. To get a BitLocker recovery key, use the Reveal Microsoft Entra ID BitLocker Recovery Key request. - The
NotAvaliabletype of theEFlrItemStateTypeenumeration type has been renamed toNotAvailable. - The required
readOnlyproperty has been added to theEntraIdTenantItemComparisonReferenceValueModelobject. - The required
versionsCountproperty has been added to theUnstructuredDataFlrBrowseItemModelobject.
- The
backupProxiesproperty has been removed from theNASFilerServerProcessingModelobject. - The
isEnabledproperty has been removed from theVmwareObjectModelobject. - The Get Inventory Objects request no longer accepts the
resetCacheparameter.
- The
synthenticFullsproperty of theBackupJobAdvancedSettingsModel,HyperVBackupJobAdvancedSettingsModel,AgentBackupJobAdvancedSettingsModelandAgentBackupPolicyAdvancedSettingsModelobjects has been renamed tosyntheticFulls. - The
RemoveDataproperty of theFullBackupMaintenanceModelobject has been renamed toremoveData. - The
credentialsIdandcredentialsTypeproperties of theGuestOsCredentialsPerMachineModelobject have been replaced with thecredentialsproperty. - The
guestProcessingproperty has been removed from theWindowsAgentManagementBackupWorkstationPolicyModelandWindowsAgentManagementBackupWorkstationPolicySpecobjects. - The
FileBackupJobObjectModelandObjectStorageBackupJobObjectModelobjects are now child schemas of the newUnstructuredBackupJobObjectModelbase object. Thepathproperty has been moved to the base object, and the requiredtypediscriminator property has been added.
The expirationDate and supportExpirationDate properties have been removed from the InstalledLicenseModel object and added to the InstanceLicenseSummaryModel and SocketLicenseSummaryModel objects.
The Scan Backups with Antivirus or YARA Rules request now accepts the new MalwareBackupScanBaseSpec base object in its request body. The scanMode, scanEngine, scanRange and continueScan properties of the MalwareBackupScanSpec object have been moved to the base object, and the required type discriminator property has been added.
The OpenSSL3v13 type of the EHostComponentType enumeration type has been renamed to OpenSSL300.
- The
Regulartype of theEReplicaTypeenumeration type has been renamed toSnapshot. TheSnapshotdiscriminator value of theReplicaModelobject now maps to theRegularReplicaModelchild schema. - The
policyTagFilterparameter of the Get All Replicas request has been replaced with thepolicyUniqueIdFilterparameter. ThepolicyTagFilterproperty of theReplicasFiltersobject has been replaced with thepolicyUniqueIdFilterproperty.
- The
DDBoost,HPStoreOnceIntegration,QuantumandSmartObjectS3types of theERepositoryTypeenumeration type have been renamed toDellDataDomain,HPEStoreOnce,QuantumDXiandS3Integrated. - The
pathproperty of theLinuxLocalRepositorySettingsModelandWindowsLocalRepositorySettingsModelobjects is now required. - The
accountsandencryptionSettingsproperties of theRepositoryAccessPermissionsModelobject are now required.
- The required
networkSecurityGroupproperty has been added to theAzureComputeNetworkModelobject. - The
mountServerId,helperHost,helperApplianceandoriginalHostproperties of theLinuxFlrMountServerSettingsobject have been moved to the following child schemas:LinuxMountServerFlrMountServerSettingsLinuxHelperHostFlrMountServerSettingsLinuxHelperApplianceFlrMountServerSettingsLinuxOriginalHostFlrMountServerSettings
- The
mountServerproperty of theLinuxFlrMountSpecobject is now required. - The
permissionsproperty of theUnstructuredDataRestoreOptionsModelobject is now required.