This section describes the latest changes and features introduced in the Veeam Backup for Microsoft Azure REST API v8.

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

The following changes in the REST API schemas were made:

• HTTP POST /databases/export request:

  • Added the DatabaseExportOptions required request body schema.

• HTTP POST /databases/rescan request:

  • Added the DatabaseOptions required request body schema.

• HTTP PUT /system/privateDeployment/state request:

  • Removed the messageService required property from the SetDeploymentModeRequest request body schema.

The following query parameters were changed in the HTTP requests:

• HTTP POST /accounts/azure/service/{accountId}/checkPermissions request:

  • Changed the type of the subscriptionId query parameter from string to array.

The following query parameters were removed from the HTTP requests:

• HTTP POST /accounts/azure/service/export request:

  • accountIds

• HTTP POST /accounts/standard/export request:

  • AccountIds

• HTTP POST /cosmosDb/export request:

  • cosmosDbAccountIds

• HTTP POST /cosmosDb/rescan request:

  • AccountTypes
  • CosmosDbAccountsFromProtectedRegions
  • ProtectionStatus
  • RegionIds
  • SearchPattern
  • ServiceAccountId
  • SoftDeleted
  • SubscriptionId
  • TenantId

• HTTP POST /databases/export request:

  • databaseIds

• HTTP POST /databases/rescan request:

  • AssignableBySqlAccountId
  • BackupDestination
  • CredentialsState
  • DbFromProtectedRegions
  • ProtectionStatus
  • RegionIds
  • SearchPattern
  • ServiceAccountId
  • SubscriptionId
  • TenantId

• HTTP POST /fileShares/export request:

  • fileShareIds

• HTTP POST /license/export request:

  • LicensedResourceIds

• HTTP POST /repositories/export request:

  • RepositoryIds

• HTTP POST /users/export request:

  • UserIds

• HTTP POST /virtualMachines/export request:

  • existsState
  • virtualMachineIds
  • vmFromProtectedRegions

• HTTP POST /virtualMachines/rescan request:

  • BackupDestination
  • ExistsState
  • ProtectionStatus
  • RegionIds
  • ResourceGroupId
  • SearchPattern
  • ServiceAccountId
  • SubscriptionId
  • TenantId
  • VmFromProtectedRegions

• HTTP POST /workers/export request:

  • vmNames

• HTTP POST /workers/networkConfiguration/export request:

  • RegionIds

• HTTP POST /workers/profiles/export request:

  • RegionIds

The REST API v8 introduces new resource collections and operations that support new features released in the latest version of Veeam Backup for Microsoft Azure.

The following new resource collections were introduced in the Veeam Backup for Microsoft Azure REST API v8:

• /flr — you can restore individual files and folders of an Azure VM to the original location.
• /policy/slaBased — you can retrieve SLA compliance results of each SLA-based backup policy.
• /policyTemplates/slaTemplate — you can view and configure SLA templates in Veeam Backup for Microsoft Azure.
• /policyTemplates/storageTemplate — you can view and configure storage templates in Veeam Backup for Microsoft Azure.
• /policy/slaBased/virtualMachines — you can view and configure Azure VM SLA-based backup policies in Veeam Backup for Microsoft Azure.

The following new operations were added to the existing resource collections in the Veeam Backup for Microsoft Azure REST API v8:

• HTTP POST /cloudInfrastructure/cosmosDb/{cosmosDbAccountId}/estimateThroughputCost — calculates the estimated hourly/daily/monthly cost of specific throughput settings configured for a Cosmos DB for MongoDB account with the specified ID.

• HTTP POST /protectedItem/cosmosDb/{cosmosDbAccountId}/deleteContinuousBackups — removes backups created using the Continuous backup option for a specifiс Cosmos DB account from the Veeam Backup for Microsoft Azure configuration database.

• HTTP GET /repositories/validateDelete — validates whether the specified backup repositories are not used by any backup policies or storage templates and can be deleted from Veeam Backup for Microsoft Azure.

The following endpoints were deleted in the Veeam Backup for Microsoft Azure REST API v8:

• HTTP GET /api/v7/snapshotBackup/settings — Get Snapshot-Based Backup Settings.

• HTTP PUT /api/v7/snapshotBackup/settings — Modify Snapshot-Based Backup Settings.

• HTTP POST /api/v7/snapshotBackup/enable — Enable Snapshot-Based Backup.

• HTTP POST /api/v7/snapshotBackup/disable — Disable Snapshot-Based Backup.