This section describes changes introduced in the Veeam Backup for Microsoft 365 REST API v8 that were not present in v7.0.

The following list contains changes that cause the Veeam Backup for Microsoft 365 REST API v8 to function differently:

• The /objectstoragerepositories resource collection was removed.

• The following methods were removed:

  • DELETE /DataRetrievals/{dataRetrievalId}
  • PUT /EncryptionKeys/{keyId}
  • POST /Organizations/{organizationId}/Jobs
  • GET /Organizations/{organizationId}/Jobs
  • GET /JobSessions/Changes
  • PUT /ManagementMode
  • GET /objectstoragerepositories/{repositoryId}
  • PUT /objectstoragerepositories/{repositoryId}
  • DELETE /objectstoragerepositories/{repositoryId}
  • GET /objectstoragerepositories
  • POST /objectstoragerepositories
  • GET /RestorePoints/Changes
  • GET /RestorePoints/{restorePointId}/protectedMailboxes
  • GET /RestorePoints/{restorePointId}/protectedTeams
  • GET /RestorePoints/{restorePointId}/protectedSites
  • GET /RestorePoints/{restorePointId}/protectedOnedrives
  • GET /RestorePoints/{restorePointId}/protectedUsers
  • GET /RestorePoints/{restorePointId}/protectedGroups

• Response codes of HTTPS methods were unified:

  • The HTTP POST method returns the HTTP response code 204 No Content, 201 Created or 200 OK
  • The HTTP PUT method returns the HTTP response code 204 No Content
  • The HTTP GET method returns the HTTP response code 200 OK
  • The HTTP DELETE method returns the HTTP response code 204 No Content

Response codes were changed for the following methods:

• POST /token/logout
• POST /S3CompatibleResources/buckets/{bucketName}/folders
• POST /S3Resources/buckets/{bucketName}/folders
• PUT /Accounts/{accountId}
• PUT /AuditEmailSettings
• POST /AuditEmailSettings/SendTestEmail (formerly POST /AuditEmailSettings/SendTest)
• POST /AzureResources/containers/{containerName}/folders
• POST /BackupRepositories
• PUT /BackupRepositories
• POST /BackupRepositories/{repositoryId}/explore
• POST /CopyJobs
• POST /CopyJobs/{id}/start
• POST /EncryptionKeys
• PUT /ExclusionSettings
• PUT /GlobalRetentionExclusionSettings
• PUT /HistorySettings
• PUT /InternetProxySettings
• POST /Jobs/{jobId}/start
• POST /Jobs/{jobId}/explore
• PUT /License/AutoUpdate
• POST /licensing/statistic/reports/{reportId}/approve
• POST /Organizations/{organizationId}/AuditItems
• POST /Organizations/{organizationId}/AuditItems/remove
• PUT /Organizations/{organizationId}/BackupAccounts
• PUT /Organizations/{organizationId}/BackupApplications
• POST /Organizations, POST /Organizations/{organizationId}/explore
• PUT /Organizations/{organizationId}/RetentionExclusion
• POST /Organizations/{organizationId}/Sync
• POST /Proxies, PUT /Proxies/{proxyId}
• POST /Proxies/{proxyId}/Rescan
• POST /Proxies/{proxyId}/Remove
• POST /Proxies/Rescan
• POST /Organizations/{organizationId}/RbacRoles
• POST /RepositorySynchronizeSessions/{sessionId}/StopSynchronize
• POST /RestoreSessions/{restoreSessionId}/Stop
• POST /Organization/Explore
• POST /Organization/OperatorExplore
• PUT /VboEmailSettings
• POST /VboEmailSettings/SendTestEmail (formerly POST /VboEmailSettings/SendTest)
• POST /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/sendToDefaultAddress
• POST /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/sendToDifferentAddress
• POST /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/sendToDefaultAddress
• POST /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/sendToDifferentAddress
• PUT /VexEmailSettings
• POST /VexEmailSettings/SendTestEmail (formerly POST /VexEmailSettings/SendTest)
• POST /RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/send
• POST /RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/{documentId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/{documentId}/Versions/{versionId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/send
• POST /RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/Versions/{versionId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments/{attachmentId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Versions/{versionId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/{folderId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/{folderId}/Versions/{versionId}/send
• POST /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Libraries/{libraryId}/send
• PUT /VeodEmailSettings
• POST /VeodEmailSettings/SendTestEmail
• PUT /VespEmailSettings
• POST /VespEmailSettings/SendTestEmail
• POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files/send
• POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/files/{fileId}/send
• POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/send
• POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/{postId}/send
• PUT /VetEmailSettings
• POST /VetEmailSettings/SendTestEmail (formerly POST /VetEmailSettings/SendTest)

This section lists new operations introduced in the Veeam Backup for Microsoft 365 REST API v8:

• Changing owner for backup repositories from one to another: Backup Repository Change Owner Sessions, Change Owner for Backup Repository by Repository ID.
• Getting information about actual health status of the NATS server and the PostgreSQL configuration database: Health.
• Creating a backup job for an organization with the specified ID: Create Backup Job.
• Adding backup applications to the specified Microsoft 365 organization: Add Backup Applications.
• Replacing existing backup applications with new ones for the specified Microsoft 365 organization: Replace Backup Applications.
• Removing backup applications from the specified Microsoft 365 organization: Remove Backup Applications.
• Getting status of synchronization of Microsoft organization objects with the organization cache database for all organizations: Get Synchronization Status.
• Enabling maintenance mode for a backup proxy server with the specified ID: Enable Maintenance Mode for Backup Proxy Server.
• Disabling maintenance mode for a backup proxy server with the specified ID: Disable Maintenance Mode for Backup Proxy Server.
• Checking the SSH connection to a Linux machine: Check SSH Connection.
• Managing backup proxy pools: Backup Proxy Pools.
• Getting users protected by Veeam Backup for Microsoft 365: Get Protected Users, Get Protected User.
• Getting groups protected by Veeam Backup for Microsoft 365: Get Protected Groups, Get Protected Group.
• Getting SharePoint sites protected by Veeam Backup for Microsoft 365: Get Protected Sites, Get Protected Site.
• Getting teams protected by Veeam Backup for Microsoft 365: Get Protected Teams, Get Protected Team.
• Getting a restore session statistics: Get Restore Session Statistics.
• Configuring OAuth 2.0 authentication to send email notifications on behalf of Google or Microsoft 365 account in Veeam Explorer for Microsoft Exchange: Prepare to Authentication Request, Complete Authentication.
• Configuring OAuth 2.0 authentication to send email notifications on behalf of Google or Microsoft 365 account in Veeam Explorer for Microsoft OneDrive for Business: Prepare to Authentication Request, Complete Authentication.
• Configuring OAuth 2.0 authentication to send email notifications on behalf of Google or Microsoft 365 account in Veeam Explorer for Microsoft SharePoint: Prepare to Authentication Request, Complete Authentication.
• Configuring OAuth 2.0 authentication to send email notifications on behalf of Google or Microsoft 365 account in Veeam Explorer for Microsoft Teams: Prepare to Authentication Request, Complete Authentication.
• Getting events occurred in Veeam Backup for Microsoft 365: Events.
• Configuring the Veeam Backup for Microsoft 365 update settings: Configuration.
• Restoring backed-up Microsoft Teams tabs of multiple channels: Restore Tabs of Multiple Channels.

The following list contains changes to specification structure and format:

• The default value was changed from true to false for the disable_antiforgery_token parameter in the request of the POST /token method. For more information, see Request Authorization Tokens.

• The /AuditEmailSettings/SendTest endpoint was renamed to /AuditEmailSettings/SendTestEmail.

• The /VboEmailSettings/SendTest endpoint was renamed to /VboEmailSettings/SendTestEmail.

• The /VexEmailSettings/SendTest endpoint was renamed to /VexEmailSettings/SendTestEmail.

• The /VetEmailSettings/sendTest endpoint was renamed to /VetEmailSettings/SendTestEmail.

• The iaStorageClassEnabled property was renamed to standardIaStorageClassEnabled in the request body and response schemas describing the Amazon S3 object storage properties.

• The instanceType property was renamed to instanceTypeName in the request body and response schemas describing the Amazon archiver appliance properties.

• The virtualMachineSize property was renamed to virtualMachineSizeName in the request body and response schemas describing the Azure archiver appliance properties.

• The channelId parameter was moved from query to path for the GET /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/files/{fileId} (formerly GET /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files/{fileId}) method.

• The channelId parameter was added to the request path for the following methods:

  • GET /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/files/{fileId}/versions (formerly GET /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files/{fileId}/versions)
  • POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/files/{fileId}/save (formerly POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files/{fileId}/save)
  • POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/files/{fileId}/send (formerly POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files/{fileId}/send)
  • POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/files/{fileId}/restore (formerly POST /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/files/{fileId}/restore)

• The POST /Organizations/{organizationId}/Jobs method was substituted with the POST /Jobs method.

• The POST /Organizations/{organizationId}/BackupApplications method is now used to add backup applications to the specified Microsoft 365 organization instead of the PUT /Organizations/{organizationId}/BackupApplications method. The PUT /Organizations/{organizationId}/BackupApplications method is used to replace existing backup applications with new ones.

The following list contains changes to operations and schemas. Note that these changes do not affect the Veeam Backup for Microsoft 365 REST API v7.0 functionality:

Format of the response was changed to page for the following methods:

• GET /BackupRepositories
• GET /CopyJobs
• GET /DataRetrievals
• GET /DataRetrievals/{dataRetrievalId}/mailboxes
• GET /DataRetrievals/{dataRetrievalId}/teams
• GET /DataRetrievals/{dataRetrievalId}/webs
• GET /DataRetrievals/{dataRetrievalId}/onedrives
• GET /Jobs
• GET /Jobs/{jobId}/SelectedItems
• GET /Jobs/{jobId}/ExcludedItems
• GET /Organizations
• GET /Proxies

• The extendedView parameter was removed from the request of the GET /Proxies and GET /Proxies/{proxyId} methods.

• The trustedServerCertificateThumbprint and trustServerCertificate parameters were added to the request of the following methods:

  • GET /S3CompatibleResources/buckets
  • GET /S3CompatibleResources/buckets/{Name}
  • GET /S3CompatibleResources/buckets/{bucketName}/folders
  • POST /S3CompatibleResources/buckets/{bucketName}/folders
  • GET /S3CompatibleResources/buckets/{bucketName}/folders/{Name}

• The organizationId parameter was added to the request of the following methods:

  • GET /Accounts
  • GET /CopyJobs
  • GET /EncryptionKeys

• The proxyPoolId and organizationId parameters were added to the request of the GET /BackupRepositories method.

• The force parameter was added to the request of the POST /DataRetrievals and PUT /DataRetrievals/{dataRetrievalId} methods.

• The organizationId and repositoryId parameters were added to the request of the GET /Jobs method.

• The status parameter was added to the request of the GET /JobSessions method.

• The type parameter was added to the request of the GET /JobSessions/{sessionId}/LogItems method.

• The backedUpOrganizationId parameter was added to the request of the GET /LicensedUsers and GET /licensing/statistic/usage methods.

• The msid and backedUpOrganizationId parameters were added to the request of the GET /Organizations method.

• The includeSearchSites parameter was added to the request of the GET /Organizations/{organizationId}/Sites method.

• The detectedSkuType parameter was added to the request of the GET /Organizations/{organizationId}/Users method.

• The userId, groupId, siteId and teamId parameters were added to the request of the GET /RestorePoints method.

• The following parameters were added to the request of the GET /RestoreSessions method:

  • endTimeFrom
  • endTimeTo
  • orderAsc
  • orderBy
  • includeM365BackupStorage

• The orderAsc parameter was added to the request of the GET /DataRetrievalSessions/{sessionId}/LogItems and the GET /JobSessions/{sessionId}/LogItems methods.

• The skipItemUpdate parameter was added to the request of the following methods:

  • POST /Jobs
  • PUT /Jobs
  • POST /Jobs/{jobId}/SelectedItems
  • PUT /Jobs/{jobId}/SelectedItems/{itemId}
  • POST /Jobs/{jobId}/ExcludedItems
  • PUT /Jobs/{jobId}/ExcludedItems/{itemId}

• The operation failure response schema now includes multiple error code values (errorCode) and error stack trace (stackTrace).
• The integration value was removed from the grant_type property for the POST /token method.
• The Hours12 value was added to the periodicallyEvery property when configuring schedule settings for backup and backup copy jobs.
• The oneZoneIaStorageClassEnabled property was added to the request body and response schemas describing the Amazon S3 object storage properties.
• The name and description properties were removed from the request body and response schemas describing object storage properties.
• The ipRanges property was added to the request body and response schemas describing properties of the Amazon archiver appliance and Azure archiver appliance.
• Properties of a backup proxy server in the request body and response schemas were expanded with properties included to sshSettings.
• The oneDriveId property was added to the request body and response schemas describing properties of backed-up OneDrive documents and OneDrive folders.
• The siteId and itemId properties were added to the request body and response schemas describing properties of backed-up SharePoint item attachments.
• The siteId property was added to the request body and response schemas describing properties of backed-up SharePoint documents, folders, items, libraries, and lists.
• The request body schema was added to the DELETE /Jobs/{jobId}/SelectedItems method allowing to specify an array of IDs of the items that you want to remove from the backup job processing list.

Request Body Schema

• The proxyPoolId, ignoreProxyPoolApplianceAccessValidation and organizationId properties were added to the request body schema of the POST /BackupRepositories and PUT /BackupRepositories/{repositoryId} methods.
• The organizationId property was added to the request body schema of the POST /EncryptionKeys method.
• The organizationId property was added to the request body schema of the POST /licensing/statistic/reports/{reportId}/approve method.
• The immutabilityPeriodDays and enableImmutabilityGovernanceMode properties were added to the request body schema of the POST /BackupRepositories and PUT /BackupRepositories/{repositoryId} methods.
• The loginGraphAppOrganizationId property was added to the request body schema of the POST /DeviceCode method.
• The repositoryId property was added to the request body schema of the POST /Organization/OperatorExplore method.
• The restoreMembers property was added to the request body schema when restoring backed-up Microsoft Teams channels.

Response Schema

• The isDeleted and proxyId properties were removed from the response schema of the following methods:

  • GET /BackupRepositories/{repositoryId}/GroupData
  • GET /BackupRepositories/{repositoryId}/GroupData/{groupId}
  • GET /BackupRepositories/{repositoryId}/SiteData
  • GET /BackupRepositories/{repositoryId}/SiteData/{siteId}
  • GET /BackupRepositories/{repositoryId}/OneDriveData
  • GET /BackupRepositories/{repositoryId}/OneDriveData/{oneDriveId}
  • GET /BackupRepositories/{repositoryId}/MailboxData
  • GET /BackupRepositories/{repositoryId}/MailboxData/{mailboxId}
  • GET /BackupRepositories/{repositoryId}/TeamData
  • GET /BackupRepositories/{repositoryId}/TeamData/{teamId}
  • GET /BackupRepositories/{repositoryId}/UserData
  • GET /BackupRepositories/{repositoryId}/UserData/{userId}

• The proxyId property was removed from the response schema of the GET /DataRetrievals, POST /DataRetrievals and GET /DataRetrievals/{dataRetrievalId} methods.

• The runNow, selectedItems and excludedItems properties were removed from the response schema of the GET /Jobs/{jobId}, POST /Jobs, GET /Jobs and GET /CopyJobs/{id}/BackupJob methods.

• The msid and backedUpOrganizationId properties were added to the response schema of the GET /Organizations, POST /Organizations and GET /Organizations/{organizationId} methods and to the request body schema of the PUT /Organizations/{organizationId} and POST /Organizations methods.

• The msid property was added to the response schema of the following methods:

  • GET /BackupRepositories/{repositoryId}/OrganizationData
  • GET /BackupRepositories/{repositoryId}/OrganizationData/{organizationId}
  • GET /BackupRepositories/{repositoryId}/SiteData
  • GET /BackupRepositories/{repositoryId}/SiteData/{siteId}
  • GET /BackupRepositories/{repositoryId}/TeamData
  • GET /BackupRepositories/{repositoryId}/TeamData/{teamId}

• The following properties were added to the response schema of the GET /BackupRepositories, POST /BackupRepositories and GET /BackupRepositories/{repositoryId} methods:

  • proxyPoolId
  • organizationId
  • isOutdated
  • isIndexed
  • isOutOfOrder
  • outOfOrderReason

• The organizationId property was added to the response schema of the GET /EncryptionKeys, POST /EncryptionKeys, GET /EncryptionKeys/{keyId} methods.

• The organizationId and eTag properties were added to the response schema of the following methods:

  • GET /Jobs
  • GET /Jobs/{jobId}
  • POST /Jobs
  • GET /CopyJobs/{id}/BackupJob
  • GET /CopyJobs
  • POST /CopyJobs
  • GET /CopyJobs/{id}
  • GET /Jobs/{jobId}/CopyJob

• The jobId, eTag, proxyId and proxyPoolId properties were added to the response schema of the following methods:

  • POST /CopyJobs/{id}/start
  • POST /Jobs/{jobId}/start
  • GET /JobSessions
  • GET /JobSessions/{jobSessionsId}

• The repositoryId, proxyId and proxyPoolId properties were added to the response schema of the GET /DataRetrievalSessions and GET /DataRetrievalSessions/{dataRetrievalSessionId} methods.

• The immutabilityPeriodDays and enableImmutabilityGovernanceMode properties were added to the response schema of the following methods:

  • GET /BackupRepositories
  • POST /BackupRepositories
  • GET /BackupRepositories/{repositoryId}
  • PUT /BackupRepositories/{repositoryId}

• The repositoryId and protectedObjectsCount properties were added to the response schema of the GET /Organizations/{organizationId}/usedRepositories method.

• The eTag and msid properties were added to the response schemas describing properties of an organization group, an organization site, a team, and an organization user.

• The assignedLicenses property was added to the response schema describing properties of an organization user.

• The response schema was expanded with new properties for the GET /Organizations/SyncState and GET /Organizations/{organizationId}/SyncState methods.

• The operatingSystem, proxyPoolId, maintenanceModeState, cpuUsagePercent, memoryUsagePercent, version, serviceAccount and role properties were added to the response schema of the GET /Proxies, POST /Proxies, GET /Proxies/{proxyId} methods. The threadsNumber property was removed.

• The eTag, objectsEtag and immutabilityExpiresOn properties were added to the response schema of the GET /Organization/LoggedInUser/RestorePoints, GET /RestorePoints, GET /RestorePoints/{restorePointId} methods.

• The eTag property was added to the response schema of the following methods:

  • POST /BackupRepositories/{repositoryId}/explore
  • POST /DataRetrievals/{dataRetrievalId}/explore
  • POST /Jobs/{jobId}/explore
  • POST /Organizations/{organizationId}/explore
  • GET /RestoreSessions
  • GET /RestoreSessions/{restoreSessionId}
  • POST /Organization/Explore
  • POST /Organization/OperatorExplore

• The following properties were added to the response schema of the GET /RestoreSessions/{restoreSessionId}/Events/{eventId} and GET /RestoreSessions/{restoreSessionId}/Events methods:

  • organizationId
  • backedUpOrganizationId
  • userId
  • groupId
  • siteId
  • teamId

• The mailboxId property was added to the response schema of the following methods:

  • GET /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/folders
  • GET /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/folders/{folderId}
  • POST /RestoreSessions/{restoreSessionId}/organization/searchExchange
  • POST /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/folders/{folderId}/search
  • GET /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}
  • GET /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items
  • POST /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/search
  • POST /RestoreSessions/{restoreSessionId}/organization/mailboxes/search

• The authenticationType, clientId, tenantId, userId, mailApiUrl and isAuthenticated properties were added to the response schema of the GET /VexEmailSettings, GET /VeodEmailSettings, GET /VespEmailSettings and GET /VetEmailSettings methods.

• The teamId property was added to the response schema describing properties of backed-up Microsoft Teams channels, files, posts, and tabs.

• The teamId and channelId properties were added to the response schema when getting backed-up Microsoft Teams items contained in a channel.

• The path property was added to the response schema of the GET /RestoreSessions/{restoreSessionId}/Statistics method.

• The jobSessionConfigType property was added to the response schema of the GET /JobSessions and GET /JobSessions/{jobSessionsId} methods.

• The isMigrationLocked property was added to the response schema of the POST /BackupRepositories, GET /BackupRepositories and GET /BackupRepositories/{repositoryId} methods.