Resource Changes

In this article

    The following list contains changes to operations and schemas. Note that these changes do not affect REST API v2 functionality.

    Collection Changes

    The following changes in resource collections were made:

    • The /protectedItem resource collection that retrieved information on all Azure resources protected by a backup policy was depricated and replaced by the /protectedItem/vm and /protectedItem/sql collections.

    For more information on new resource collections, see New Operations.

    Query Parameter Changes

    The following changes in query parameters of HTTP requests were made:

    • GET /api/v3/repositories — Get Collection of backup repositories
    • Added the following query parameters: TenantId, ServiceAccountId.
    • GET  /api/v3/repositories/{repositoryId} — Get a specific backup repository data
    • Added the following query parameters: TenantId, ServiceAccountId.
    • POST /api/v3/repositories — Create a new backup repository:
    • Removed the following query parameters: importIfFolderHasBackup, autoCreateTiers.
    • GET  /api/v3/restorePoints — Get Collection of restore points:
    • Added the following query parameters: DataRetrievalStatuses, PointInTime.
    • GET  /api/v3/accounts/standard - Get Collection of SMTP and SQL server accounts created in Veeam Backup for Microsoft Azure:
    • Added the following query parameters: Type.

    Response Code Changes

    • Response code 200 Success was deleted and replaced by 201 Success for the following POST requests:
    • POST /api/v3/policies
    • POST /api/v3/accounts/standard
    • POST /api/v3/cloudInfrastructure/storageAccounts/{azureStorageId}/containers
    • POST /api/v3/users
    • POST /api/v3/workerConfiguration
    • Response code code 200 Success was deleted and replaced by 202 Accepted for the following operations:
    • POST /api/v3/repositories
    • DELETE /api/v3/restorePoints/{restorePointId}
    • POST /api/v3/restorePoints/{restorePointId}/restoreDisk
    • POST /api/v3/restorePoints/{restorePointId}/restoreVm
    • POST /api/v3/restorePoints/{restorePointId}/restoreFile
    • POST /api/v3/virtualMachines/takeSnapshot
    • Response code 409 Conflict was added to the GET /api/v3/cloudInfrastructure/storageAccounts endpoint.

    Schema Changes

    The following changes in the REST API schemas were made:

    • StandardAccountV3 schema:
    • Added the kind property.
    • PolicyV3 schema:
    • Added the serviceAccountId property.
    • RepositoryCreateFromClientV2 schema renamed to RepositoryCreateFromClientWithKeyVaultV3.
    • Added the keyVaultId request body parameter.
    • Added the keyVaultKeyUri request body parameter.
    • Added the importIfFolderHasBackup request body parameter.
    • Added the autoCreateTiers request body parameter.
    • Added the RepositoryValidationConfigV3 schema to the POST /api/v3/repositories/settings/validate request. The RepositoryCreateFromClientV3 schema included to the RepositoryValidationConfigV3.
    • RestorePointV3 schema:
    • Added the type property.
    • Added the dataRetrievalStatus property.
    • Added the retrievedDataExpirationDate property.
    • Added the notifyBeforeRetrievedDataExpirationHours property.
    • Replaced NewStandardAccountV2 schema by NewStandardAccountFromClientV3.
    • UserV3 schema:
    • Added the role parameter.
    • Added the type parameter.
    • Added the identityProviderEntityId parameter.
    • VmSnapshotV3 schema:
    • Added the serviceAccountId parameter.
    • WorkerV3 schema:
    • Added the purpose parameter.