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

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 following changes affect most of the REST API functionality:

• The 1.1-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 lifetime of access tokens is increased to 60 minutes. To learn more about the authorization process, see Authorization and Security.

The following new features are introduced in REST API 1.1-rev1.

In this version, the REST API supports two new types of jobs:

• vSphereReplica — VMware vSphere replication jobs
• CloudDirectorBackup — VMware Cloud Director backup jobs

For these new jobs, all existing operations are supported.

Operations

• Get All Jobs
• Create Job
• Get All Job States
• Get Job
• Edit Job
• Delete Job
• Start Job
• Stop Job
• Disable Job
• Enable Job

Now you can manage VMware Cloud Director servers. The ManagedServerModel object now includes the CloudDirectorHostModel object, and the EManagedServerType enum type now have the CloudDirectorHost value.

For Cloud Director servers, all existing operations are supported. To get an array of vCenter Servers attached to a specific Cloud Director server, use the new Get vCenter Servers Attached to Cloud Director Server request.

Operations

• Get vCenter Servers Attached to Cloud Director Server
• Get All Servers
• Add Server
• Get Server
• Edit Server
• Remove Server

The REST API allows you to get WAN accelerators that you can use when configuring replication jobs.

Operations

• Get All WAN Accelerators
• Get WAN Accelerator

New endpoints for managing restore points of snapshot replicas allow you get restore points for further failover to VM replicas.

Operations

• Get All Replica Restore Points
• Get Replica Restore Point

Now you can use the REST API to fail over to VM replicas and fail back from VM replicas to production VMs.

Operations

• Start Failover
• Start Planned Failover
• Start Permanent Failover
• Undo Failover
• Start Failback
• Switch over to Production
• Change Switchover Time
• Commit Failback
• Undo Failback

REST API 1.1-rev1 supports all file restore operations both for Microsoft Windows and Linux machines. You can restore files and folders to the original location or another machine including Linux physical machines with Veeam Agent installed.

Operations

• Start File Restore
• Unmount File System
• Get All File Restore Mounts
• Get File Restore Mount
• Browse File System
• Compare Attributes
• Compare Files and Folders
• Search for Files and Folders
• Search for Files and Folders
• Browse Search Results
• Restore Files and Folders to Original Location
• Restore Files and Folders to Another Location
• Prepare Files and Folders for Download
• Download Files and Folders

To get a Veeam Agent machine use the following requests.

Operations

• Get All Protected Computers
• Get Protected Computer

For REST API 1.1-rev1, a new inventory browser is implemented, which supports not only browsing VMware vSphere infrastructure but also VMware Cloud Director.

Operations

• Get All Servers
• Get Inventory Objects
• Rescan Inventory Objects

Now you can manage malware events. Use a third-party antivirus software and integrate it with the REST API to create a malware event that will trigger quick backup. For details on enabling Incident API, see the Incident API section of the Veeam Backup & Replication User Guide.

Operations

• Get All Malware Events
• Create Malware Event
• Get Malware Event

Using REST API 1.1-rev1, you can configure receiving SNMP traps containing job results and set up an external syslog server that processes the events written by Veeam Backup & Replication.

Operations

• Get General Options
• Edit General Options

REST API 1.1-rev1 also supports managing KMS servers for data encryption.

Operations

• Get All KMS Servers
• Add KMS Server
• Get KMS Server
• Edit KMS Server
• Remove KMS Server
• Change KMS Server Certificate

REST API 1.1-rev1 includes new operations for Google service accounts.

Operations

• Get Google Authentication Information
• Change Google Service Account

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

• Get All VMware vSphere Servers
• Get VMware vSphere Server Objects

Use the new inventory browser to browse inventory objects. It supports browsing not only VMware vSphere infrastructure but also VMware Cloud Director.

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

The EVmwareInventoryType enum type now includes the DVSNetwork value.

The Get Cloud Hierarchy request now has the resetCache parameter that allows you to reset the cache for this request.

• Now the isHighPriority, storage, guestProcessing and schedule properties of the BackupJobSpec object are not required in the request body when you create a job. If you do not specify a property, it is filled in with a default value.

• Now the localTime property of job schedule is set to the hh:mm time format.

• Now the BackupStorageSettingsEncryptionModel object contains the kmsServerId and encryptionType property that defines the encryption method: ByUserPassword or ByKms.

Added the malwareStatus property that indicates a malware status of restore points: Clean, Suspicious or Infected. The property is optional.

Now you can granularly specify datastores for VM disks and VM configuration files.

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

• FileLevelRestore
• LinuxFileLevelRestore
• ReplicaJob
• ConfigurationResynchronize
• Failover
• PlannedFailover
• PermanentFailover
• UndoFailover
• Failback
• CommitFailback
• UndoFailback
• SwitchReplicaToProduction
• CloudDirectorVmRestore
• CloudDirectorVAppRestore
• MalwareDetection
• Automation

Now the ManageServerImportSpecCollection object includes the cloudDirectorHosts property.

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

The ManagedServerModel object now has the status property, which shows an availability status of the server.

In REST API 1.1-rev1, the following paths are renamed.

In REST API 1.1-rev1, the following properties are renamed:

The Backup value of the ESessionType enum is renamed to BackupJob.