Resource Changes

The following new resource parameters and parameter values were introduced in REST API 1.7.

Logon Sessions

The v1_7 version was added to the /sessionMngr resource. For details, see HTTP Authentication and Versioning.

Backup Servers

The following parameters were added to the entity resource representation of the /backupServers/{ID} resource.

Element

Type

Description

WcfPort

UShort

Default certificate port used by Veeam Backup Enterprise Manager for collecting data from backup servers that have Veeam Backup & Replication 12 or later installed, for example: 9405.

VbrCertificateThumbprint

String

Certificate thumbprint of the backup server, for example: B3196B5FA2A97552A227A59F5E218C477C4971E4.

Backup Jobs

The UsePersistentGuestAgent parameter was added to the VssSnapshotOptions element for jobs and CDP policies. For details, see Application-Aware Processing Options.

Element

Type

Description

UsePersistentGuestAgent

Boolean

Defines whether to use a persistent guest agent on the protected VM for application-aware processing. Possible values:

  • True
  • False

The default value is False.

Backup Copy Jobs

The REST API supports the new multi-platform backup copy jobs that let you add multiple workload types into a single backup copy job. The JobInfo section of the new backup copy jobs contains the ImmediateBackupCopyJobInfo element that includes backup copy job settings such as linked backup jobs, backups and backup repositories. For details, see Backup Copy Job Options.

To start a backup copy job, send the POST /jobs/{ID}?action=sync request.

File Restore

When performing file-level restore of a Microsoft Windows machine, you can specify the PermissionsOnly parameter that lets you restore only permissions of a file or folder. For details, see File-Level Restore Options.

Element

Type

Description

Modifiable

Min/Max Occurrence

PermissionsOnly

Boolean

Defines whether to restore only permissions of the file or folder. The file or folder must exist on the target machine. The feature is supported for Windows machines only.

Possible values:

  • True
  • False

The default value is False.

Yes

0/1

CDP Replica Intervals

Added the IntervalType parameter to the Interval element. For details, see POST /cdpReplicas/{ID}/vms/{ID}?action=intervals.

Possible values:

  • RestoreAvailable
  • RestorePartiallyAvailable

Veeam Cloud Connect

Now the REST API supports CDP replicas and Cloud Director CDP replicas created by tenants.

Page updated 1/25/2024

Page content applies to build 12.2.0.334