This section describes changes introduced in Veeam Backup & Replication REST API 1.1-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 following new features are introduced in REST API 1.1-rev0.

Now you can obtain information about the backup server (Veeam Backup & Replication ID, backup server name or IP address, build number, cumulative patches installed on the backup server, and information about the configuration database).

Operations

Get Backup Server Information

Now you can manage object storage repositories with REST API. To make it work, the REST API contains the following improvements.

New Repository Types

You can get, add, edit and remove the following types of object storage repositories:

• Microsoft Azure Blob storage, Microsoft Azure Archive storage, and Microsoft Azure Data Box storage
• Amazon S3 storage, Amazon S3 Glacier storage, and AWS Snowball Edge storage
• Google Cloud storage
• S3 compatible storage
• IBM Cloud storage
• Wasabi Cloud storage

To manage object storage repositories, use the regular repository methods available in the previous version. For more information on how to add an object storage repository, see Adding Object Storage Repository.

Operations

• Get All Repositories
• Add Repository
• Get All Repository States
• Get Repository
• Edit Repository
• Remove Repository

Cloud Credentials

To access cloud services, you need cloud credentials. The REST API includes new methods for obtaining, adding, editing and removing cloud credentials, as well as some Microsoft Azure-specific methods for creating a new Azure AD application and configuring helper appliances required for restore of Linux-based machines.

Operations

• Get All Cloud Credentials
• Add Cloud Credentials Record
• Get Cloud Credentials Record
• Edit Cloud Credentials Record
• Remove Cloud Credentials Record
• Change Secret Key
• Change Certificate

For Microsoft Azure:

• Get Verification Code
• Register Azure AD Application
• Get All Helper Appliances
• Add or Edit Helper Appliance
• Get Helper Appliance
• Remove Helper Appliance

Cloud Browser

Cloud browser lets you browse cloud resources (compute or storage) required to configure an object storage repository. In particular, you can use the cloud browser to locate a cloud folder (or create a new one) that you want to map to a new object storage repository.

Operations

• Get Cloud Hierarchy
• New Folder

Automation: Export and Import

Just like you export and import direct attached and network attached storage systems, now you can export and import object storage systems. Additionally, like you export and import regular credentials, now you can export and import cloud credentials. For more information on export and import, see Mass Deployment.

Operations

• Export Repositories
• Import Repositories
• Export Cloud Credentials
• Import Cloud Credentials

Now you can use the REST API to manage scale-out backup repositories. The REST API includes the following new operations:

• Get, add, edit and remove a scale-out backup repository
• Manage access permissions
• Enable and disable the Sealed mode
• Enable and disable the Maintenance mode

Operations

• Add Scale-Out Backup Repository
• Get Scale-Out Backup Repository
• Edit Scale-Out Backup Repository
• Remove Scale-Out Backup Repository
• Enable Sealed Mode
• Disable Sealed Mode
• Enable Maintenance Mode
• Disable Maintenance Mode

The REST API now supports Linux hardened repositories. Before you use a managed Linux server as a hardened repository, make sure that single-use credentials are used for connection to the server. The REST API includes a new operation that enables you to change server credentials from persistent to single-use. To manage Linux hardened repositories, use the regular repository methods available in the previous version.

Operations

• Change to Single-Use Credentials
• Get All Repositories
• Add Repository
• Get All Repository States
• Get Repository
• Edit Repository
• Remove Repository

With the REST API, you can perform entire VM restore of a VMware vSphere VM to VMware vSphere. You can restore a VM from the specified restore point to the original location with initial VM settings, or to any location but with different settings.

Operations

Start Entire VM Restore

You can use the REST API to instantly recover VMware vSphere VMs to VMware vSphere. You can recover a VM from the specified restore point to the original location with initial VM settings, or to any location but with different settings. After you have performed Instant Recovery, you have to finalize it: stop publishing the recovered VM or migrate it to production.

Operations

• Start Instant Recovery
• Get All VM Mounts
• Get VM Mount
• Stop VM Publishing
• Start VM Migration

Recovery tokens are used for bare metal recovery of Veeam Agent computers. The REST API lets you create, get, edit and delete recovery tokens.

Operations

• Create Recovery Token
• Get All Recovery Tokens
• Get Recovery Token
• Edit Recovery Token
• Delete Recovery Token

Now you can manage backup jobs that include VMware vSphere objects of the Tag type. Note that objects with tags combination (or Multitag) are not supported yet. For details, see Jobs.

The following new resource properties and property values are introduced in REST API 1.1-rev0.

Now a successful HTTP DELETE request to the /api/v1/backupInfrastructure/managedServers/{id} path not only returns a 201 code but a response body with an InfrastructureItemDeletion session. To check the deletion progress, track the state parameter of the state. For more information, see Remove Server.

• Now you can specify a cleanup mode for repositories with rotated drives. To do this, use the RotatedDriveCleanupMode property in the RepositoryAdvancedSettingsModel. The property is optional.

• Now you can enable and disable the limit for concurrent tasks and limit for reading and writing speed using the new enableTaskLimit and enableReadWriteLimit properties.

• You can overwrite the owner of an object storage repository. It can be useful if the repository is owned by another backup server. In this case, specify the overwriteOwner query parameter when adding the object storage.

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

• The autoSelect property of the RepositoryShareGatewayModel model is now required.
• The string gatewayServerId property of the RepositoryShareGatewayModel model is renamed to gatewayServerIds and its type is changed to array so you can specify an array of gateway server IDs there.

For details, see Repositories.

In the SyntheticFullSettingsModel model, the days property is replaced with weekly and monthly properties. For more information, see Jobs.

In the AdvancedSmtpOptionsModel model, fixed a typo in the property name: authRequred → authRequired. For details, see General Options.