- About Veeam Backup & Replication REST API
- Overview
- How To
- Changelog
- 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 Azure Verification Code
- postRegister Azure AD 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
- Connection
- Cloud Browser
- Inventory Browser
- Traffic Rules
- General Options
- Malware Detection
- Configuration Backup
- Managed Servers
- Repositories
- getGet All Repositories
- postAdd Repository
- getGet All Repository States
- getGet Repository
- putEdit Repository
- delRemove Repository
- 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
- Proxies
- WAN Accelerators
- Jobs
- Backups
- Backup Objects
- Restore Points
- Restore
- getGet All VM Mounts
- postStart Instant Recovery
- getGet VM Mount
- postStop VM Publishing
- postStart VM Migration
- postRestore Entire VMware vSphere VM
- postRestore Entire VMware Cloud Director VM
- getGet All FCD Mounts
- postStart Instant FCD Recovery
- getGet FCD Mount
- postStop FCD Publishing
- postStart FCD Migration
- postStart File Restore
- postUnmount File System
- Backup Browsers
- getGet All File Restore Mounts
- getGet File Restore Mount
- 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
- Tasks
- Replicas
- Replica Restore Points
- Failover
- Failback
- Sessions
- Agents
- 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
This section describes changes introduced in Veeam Backup & Replication REST API 1.1-rev2.
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.1-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.
In REST API 1.1-rev2, the Veeam Security Administrator and Incident API Operator roles are added.
- Veeam Security Administrator has access to the Credentials and Encryption endpoints.
- Incident API Operator has access to the Malware Detection endpoints.
The Get Authorization Code request is deprecated in REST API 1.1-rev2.
The following minor non-breaking changes are introduced in REST API 1.1-rev2.
In REST API 1.1-rev2, you can specify single-use credentials for Linux servers that you want to use as hardened repositories in the Request TLS Certificate or SSH Fingerprint request.
Now the resourcePool
property is not required in the InstantViVMCustomizedRecoveryDestinationSpec
object.
Now the Start FCD Migration request returns a session of the FirstClassDiskQuickMigration
type.
Breaking changes cause REST API to function differently and can affect the client code.
Now you can specify either permanent or single-use credentials for Linux servers. To specify the Linux credentials type, you must use the required credentialsStorageType
property. For details, see Managed Servers.