Breaking Changes

In this article

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

    Path Parameter Changes

    In the Veeam Backup for Microsoft Azure REST API v4 the licensingPolicyChecksum and requiredSoftwareChecksum path parameters were added to the following operation:

    • POST ​/api​/v4​/licenseAgreement/accept — Accept License Agreement.

    Note that to accept license agreements on the backup appliance running Veeam Backup for Microsoft Azure version 4.0, a user must use the latest version of the REST API specification.

    Response Changes

    The 200 (OK) response was replaced by a schema of object type in the following operations:

    • POST /api/v4/accounts/azure/service/saveByToken — Add Service Account Automatically.
    • POST /api/v4/accounts/azure/repository/saveByToken — Add Repository Account Automatically.

    Query Parameter Changes

    The following changes in the REST API query parameters were made:

    • The FromUtc and ToUtc query parameters accept as an input only time specified in the UTC timezone in the following format: YYYY-MM-DDTHH:MM:SSZ.
    • The serviceAccountId query parameter has a string data type, uuid format. The parameter is requested in the following operations:
    • POST /api/v4/databases/startManualBackup — Create Backups of SQL Databases.
    • POST /api/v4/restorePoints/sql/{restorePointId}/restoreDb — Perform SQL Database Restore.
    • POST /api/v4/policies/sql/testConfiguration — Check Configuration of Backup Policy.
    • POST /api/v4/policies/sql — Create Backup Policy.
    • The dailyTime query parameter has a string data type, time-span format. The parameter is requested in the operation PUT /api/v4/settings/emailNotifications — Configure Email Notification Settings.
    • The accessTokenCache query parameter has a string data type, binary format. The parameter is requested in the following operations:
    • POST /api/v4/accounts/azure/service/isUserOwnerOfAdApp — Validate User.
    • POST /api/v4/accounts/azure/repository/saveByToken — Add Repository Account Automatically.
    • PUT /api/v4/accounts/azure/repository/updateByToken/{accountId} — Edit Automatically Created Repository Account.
    • POST /api/v4/accounts/azure/service/listAdGroups — Get List of AD Groups.
    • POST /api/v4/accounts/azure/service/saveByToken — Add Service Account Automatically.
    • PUT /api/v4/accounts/azure/service/updateByToken/{accountId} — Edit Automatically Created Service Account.
    • POST /api/v4/accounts/azure/repository/listSubscriptionsByToken — Get List of Subscriptions by Token.
    • POST /api/v4/accounts/azure/service/listSubscriptionsByToken — Get List of Subscriptions by Token.

    Response Parameter Changes

    The following changes in the REST API response parameters were made:

    • The purpose response parameter was removed from the operation GET /api/vX/workers — Get Collection of Worker Instances.
    • The result response parameter was replaced by a schema of object data type. The parameter is returned in the following operations:
    • POST /api/v4/accounts/azure/service/saveByToken — Add Service Account Automatically.
    • POST /api/v4/accounts/azure/repository/saveByToken — Add Repository Account Automatically.
    • The serviceAccountId response parameter has a string data type, uuid format. The parameter is returned in the following operations:
    • GET /api/v4/policies/sql/{policyId} — Get Backup Policy Data.
    • PUT /api/v4/policies/sql/{policyId} — Modify Backup Policy.
    • POST /api/v4/policies/sql — Create Backup Policy.
    • GET /api/v4/policies/sql — Get Collection of SQL Backup Policies.
    • The sessionId response parameter has a string data type, uuid format. The parameter is returned in the following operations:
    • POST /api/v4/databases/export — Export Collection of SQL Databases.
    • POST /api/v4/protectedItem/sql/export — Export Collection of Protected SQL Databases.
    • POST /api/v4/settings/saml2/idp/register — Import Identity Provider Metadata.
    • POST /api/v4/settings/saml2/idp/used — Change Identity Provider URL.
    • POST /api/v4/virtualMachines/export — Export Collection of Azure VMs.
    • GET /api/v4/cloudInfrastructure/availabilityZones — Get Collection of Availability Zones.
    • DELETE /api/v4/accounts/azure/repository/{accountId} — Remove Repository Account.
    • DELETE /api/v4/accounts/azure/service/{accountId} — Remove Service Account.
    • POST /api/v4/accounts/azure/service/isUserOwnerOfAdApp — Validate User.
    • POST /api/v4/cloudInfrastructure/storageAccounts/{azureStorageId}/containers — Create Blob Container in Storage Account.
    • POST /api/v4/cloudInfrastructure/virtualNetworks — Create Virtual Networks.
    • GET /api/v4/cloudInfrastructure/virtualMachineSizes — Get Collection of VM Sizes.
    • POST /api/v4/accounts/azure/repository/saveByToken — Add Repository Account Automatically.
    • PUT /api/v4/accounts/azure/repository/updateByToken/{accountId} — Edit Automatically Created Repository Account.
    • POST /api/v4/accounts/azure/repository/saveByApp — Add Repository Account Using Existing Application.
    • PUT /api/v4/accounts/azure/repository/updateByApp/{accountId} — Edit Repository Account Created Using Application.
    • POST /api/v4/accounts/azure/service/listAdGroups — Get List of AD Groups.
    • POST /api/v4/accounts/azure/service/saveByToken — Add Repository Account Automatically.
    • PUT /api/v4/accounts/azure/service/updateByToken/{accountId} — Edit Automatically Created Service Account.
    • POST /api/v4/repositories — Add Backup Repository.
    • PUT /api/v4/repositories/{repositoryId} — Modify Backup Repository Settings.
    • DELETE /api/v4/repositories/{repositoryId} — Remove Backup Repository.
    • DELETE /api/v4/policies/sql/{policyId} — Remove Backup Policy.
    • The totalCycleTime response parameter has a string data type, time-span format. The parameter is returned in the operation GET /api/vX/workers/statistics — Get Worker Instance Statistics.
    • The accessTokenCache response parameter has a string data type, binary format. The parameter is returned in the following operations:
    • POST /api/v4/accounts/azure/repository/authenticate — Authenticate Repository Account.
    • POST /api/v4/accounts/azure/service/authenticate — Authenticate Service Account.
    • The executionDuration response parameter has a string data type, time-span format. The parameter is returned in the following operations:
    • POST /api/v4/databases/startManualBackup — Create Backups of SQL Databases.
    • GET /api/v4/jobSessions/{sessionId} — Get Session Data.
    • GET /api/v4/jobSessions/{sessionId}/log — Get Session Log Details.
    • POST /api/v4/policies/sql/{policyId}/start — Start Backup Policy.
    • POST /api/v4/protectedItem/sql/{databaseId}/deleteBackups — Remove Backups of Protected SQL Database.
    • POST /api/v4/protectedItem/sql/{databaseId}/deleteManualBackups — Remove Manual Backups of Protected SQL Database.
    • POST /api/v4/repositories — Add Backup Repository.
    • PUT /api/v4/repositories/{repositoryId} — Modify Backup Repository Settings.
    • DELETE /api/v4/repositories/{repositoryId} — Remove Backup Repository.
    • DELETE /api/v4/restorePoints/sql/{restorePointId} — Remove Azure VM Restore Point.
    • POST /api/v4/restorePoints/sql/{restorePointId}/restoreDb — Perform SQL Database Restore.
    • POST /api/v4/restorePoints/sql/{restorePointId}/retrieveData — Retrieve Data from Archive.
    • GET /api/v4/jobSessions — Get Collection of Sessions.
    • POST /api/v4/virtualMachines/takeSnapshot — Create Snapshots of Azure VMs.
    • The dailyTime response parameter has a string data type, time-span format. The parameter is returned in the following operations:
    • GET /api/v4/settings/emailNotifications — Get Email Notification Settings.
    • PUT /api/v4/settings/emailNotifications — Configure Email Notification Settings.