Veeam Backup & Replication 13
REST API Reference
Related documents

Changelog

This section describes changes introduced in Veeam Backup & Replication REST API 1.2-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.

Global Changes

  • The 1.2-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.

  • When using Swagger UI with the 1.2-rev1 revision, you must specify only the access token instead of the Bearer <access_token> string in the Available authorizations window. For more information, see Authorization with Swagger UI.

New Features

The following new features are introduced in Veeam Backup & Replication REST API 1.2-rev1.

Encryption Passwords

Now you can change the passwords used for data encryption. For details, see Change Encryption Password.

Repositories

With REST API 1.2-rev1, you can rescan an array of specified backup repositories, using the Rescan Repositories request.

Backups

REST API 1.2-rev1 allows you to perform the following new operations with backups:

  • To delete a backup from disk completely or just delete a backup record from the configuration database, use the Delete Backup request.
  • To download backup metadata, send the Download Backup Metadata request.

Microsoft Entra ID

Now you can backup and restore Microsoft Entra ID conditional access policies. To enable conditional access policies backup, add the following registry key:

New-ItemProperty -Path "HKLM:SOFTWARE\Veeam\Veeam Backup and Replication" -Name "EntraIdBackupSupportsConditionalAccessPolicyRestore" -Value "1" -PropertyType DWORD -Force

Additionally, make sure that the Microsoft Entra application used for tenant authentication has required permissions. For details, see the Considerations and Limitations section of the Veeam Backup & Replication User Guide.

To back up and restore conditional access policies, use existing endpoints. For details, see Backing up and Restoring Microsoft Entra ID. To compare conditional access policies, use the following new endpoints: