Veeam Backup for Microsoft 365 8
REST API Reference
Related documents
Search

Resource Changes

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:

Pagination

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

Changes in Query Parameters

  • 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

Changes in Schemas

  • 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.

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 prpperties 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 were added to the response schema when getting backed-up Microsoft Teams items contained in a channel.

Page updated 8/14/2024

Page content applies to build 8.0.5.20

View all results across Veeam
Back to document search