Resource Changes

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

Query Parameter Changes

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

  • Removed the Display query parameter from the GET /api/v5/jobSessions operation.
  • Removed the following query parameters from the POST /api/v5/licenseAgreement/accept operation:
  • eulaChecksum
  • thirdPartyLicenseAgreementChecksum
  • licensingPolicyChecksum
  • requiredSoftwareChecksum

Note that instead of the deleted query parameters, the DocumentChecksum request body schema is now used.

Response Code Changes

The following changes in response codes of HTTP requests were made:

  • Response code 202 Accepted was added to the PUT /api/v5/accounts/azure/repository/updateByToken/{accountId} request. This code is returned by the server in case if an operation is performed in asynchronous mode.
  • Response code 204 No Content was added to the GET /api/v5/system/logs request. This code is returned by the server in case if no system logs exist for the specified time interval.

Schema Changes

The following changes in the REST API schemas were made:

  • CostEstimationData/CostEstimationTotals schema:
  • Added the totalArchiveCosts property.
  • PageOfCostEstimationItem/CostEstimationItem schema:
  • Added the archiveCost property.
  • JobSession/JobSessionType schema:
  • Added the properties PolicyArchive and SqlPolicyArchive.
  • PageOfProtectedItem/ProtectedItem schema:
  • Added the resourceParent property.
  • StorageAccount schema:
  • Added the properties isImmutableStorage and isImmutableStoragePolicyLocked.
  • StorageAccountCapabilities schema:
  • Added the recommendedConcurrency property.
  • RepositoryStatus schema:
  • Added the ReadOnly property.
  • Repository schema:
  • Added the properties immutabilityEnabled and concurrencyLimit.
  • Policy schema:
  • Added the properties archiveStatus and isArchiveBackupConfigured.
  • SqlPolicy schema:
  • Added the properties archiveStatus and isArchiveBackupConfigured.
  • RepositoryCreateFromClientWithKeyVault schema:
  • Added the concurrencyLimit property.
  • RepositoryUpdateFromClientWithKeyVault schema:
  • Added the concurrencyLimit property.
  • RepositorySecuritySettingsData schema:
  • Added the immutability property.
  • VirtualMachineRestorePoint schema:
  • Added the properties immutableTill, accessTier and latestChainSizeBytes.
  • SqlRestorePoint schema:
  • Added the properties sqlServerId, sqlServerName, immutableTill, accessTier and latestChainSizeBytes.
  • ConfigurationRestorePoint schema:
  • Added the immutableTill property.
  • FileShare schema:
  • Added the size property.
  • HTTP GET /api/v5/policies/fileShares request:
  • The PageOfPolicyFileShare response body schema replaced by PageOfFileSharePolicy schema.
  • HTTP POST /api/v5/policies/fileShares request:
  • The NewPolicyFileShareFromClient request body schema replaced by NewFileSharePolicyFromClient schema.
  • The PolicyFileShare response body schema replaced by FileSharePolicy schema.
  • HTTP GET /api/v5/policies/fileShares/{policyId} request:
  • The PolicyFileShare response body schema replaced by FileSharePolicy schema.
  • HTTP PUT /api/v5/policies/fileShares/{policyId} request:
  • The UpdatedPolicyFileShareFromClient request body schema replaced by UpdatedFileSharePolicyFromClient schema.
  • The PolicyFileShare response body schema replaced by FileSharePolicy schema.
  • HTTP GET /api/v4/policies/fileShares/{policyId}/selectedItems request:
  • The PageOfPolicyFileShareBackupItem response body schema replaced by PageOfFileSharePolicyBackupItem schema.
  • HTTP GET /api/v5/policies/fileShares/{policyId}/excludedItems request:
  • The PageOfPolicyFileShareExcludedItem response body schema replaced by PageOfFileSharePolicyExcludedItem schema.