Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Data Retrieval Jobs

The /DataRetrievals resource collection allows you to manage retrieval jobs and get a resource representation of objects whose backed-up data was retrieved.

Get Retrieval Jobs

Returns a collection of configured retrieval jobs.

SecurityBearer
Request
query Parameters
organizationId
string <uuid>

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.

repositoryId
string <uuid>

Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.

dataState
string (RESTDataRetrievalDataState)

Specifies the status of the backed-up data.

Enum: "Retrieving" "Retrieved" "ChangingAvailabilityPeriod" "Removing"
limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

Responses
200

OK

default

Operation failure response.

get/v8/DataRetrievals
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Create Data Retrieval Job
Creates a retrieval job. 
NOTE 
 You must create individual retrieval jobs for different types of objects whose backed-up data you want to retrieve. 


x-codegen-request-body-name:  dataRetrievalFromClient
SecurityBearer 
Request 
query Parameters
force
boolean
 Default:  false
Defines whether Veeam Backup for Microsoft 365 will check email notifications settings to ensure if email notifications are enabled.


 
Request Body schema: application/json
required
name
string or null
Specifies a name of the retrieval job.


 
description
string or null
Specifies a description of the retrieval job.


 
organizationId
string
Specifies the backed-up organization unique ID.


 
repositoryId
string or null <uuid> 
Specifies the ID of one of the following object storage repositories: Azure Blob Storage Archive access tier, Amazon S3 Glacier Flexible Retrieval or Amazon S3 Glacier Deep Archive storage classes.


 
pointInTime
string or null <date-time> 
Specifies point in time that you want to retrieve from one of the following object storage repositories: Azure Blob Storage Archive access tier, Amazon S3 Glacier Flexible Retrieval or Amazon S3 Glacier Deep Archive storage classes.


 
showDeleted
boolean or null
Defines whether the data retrieval session will show items that have been removed by the user before the specified point in time.


 
showAllVersions
boolean or null
Defines whether the data retrieval session will show all versions of items that have been modified by the user before the specified point in time.


 
availabilityPeriodDays
integer <int32> 
Specifies how many days you will be able to explore and restore the retrieved data using Veeam Explorers.


 
enableExpirationNotification
boolean or null
Defines whether Veeam Backup for Microsoft 365 will send a notification by email before the retrieved data expires.


 
expirationHoursThreshold
integer or null <int32> 
Specifies how many hours should remain before the retrieved data expires to send a notification by email.  Use this property only with the enableExpirationNotification property.


 
Array of objects (RESTBackupMailboxData) 
Specifies IDs of the mailboxes whose backed-up data you want to retrieve from object storage repository. For more information on how to get such IDs, see Get Mailbox Data by Repository ID.


 
Array of objects (RESTBackupOneDriveData) 
Specifies IDs of OneDrives whose backed-up data you want to retrieve from object storage repository. For more information on how to get such IDs, see Get OneDrive Data by Repository ID.


 
Array of objects (RESTBackupSiteData) 
Specifies IDs of the SharePoint sites whose backed-up data you want to retrieve from object storage repository. For more information on how to get such IDs, see Get SharePoint Data by Repository ID.


 
Array of objects (RESTBackupTeamData) 
Specifies IDs of the teams whose backed-up data you want to retrieve from object storage repository. For more information on how to get such IDs, see Get Teams Data by Repository ID.


 
amazonS3GlacierRetrievalPolicy
string or null
Specifies the retrieval policy for Amazon S3 Glacier Flexible Retrieval and Amazon S3 Glacier Deep Archive object storage repositories.


 Enum: "Expedited" "Standard" "Bulk"  
azureArchiveRetrievalPolicy
string or null
Specifies the retrieval policy for Azure Blob Storage Archive.


 Enum: "StandardPriority" "HighPriority"  
Responses 
201
Created


default
Operation failure response.


post/v8/DataRetrievals
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "organizationId": "string",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "pointInTime": "2019-08-24T14:15:22Z",
  • "showDeleted": true,
  • "showAllVersions": true,
  • "availabilityPeriodDays": 0,
  • "enableExpirationNotification": true,
  • "expirationHoursThreshold": 0,
  • "mailboxes": [
    ],
  • "oneDrives": [
    ],
  • "sites": [
    ],
  • "teams": [
    ],
  • "amazonS3GlacierRetrievalPolicy": "Expedited",
  • "azureArchiveRetrievalPolicy": "StandardPriority"
}
Response samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "storageType": "AzureArchive",
  • "amazonS3GlacierRetrievalPolicy": "Expedited",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "pointInTime": "2019-08-24T14:15:22Z",
  • "retrievedRestorePointId": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "organizationUniqueId": "string",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "dataState": "Retrieving",
  • "lastStatus": "Stopped",
  • "startTime": "2019-08-24T14:15:22Z",
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "enableExpirationNotification": true,
  • "expirationHoursThreshold": 0,
  • "type": "Exchange",
  • "showDeleted": true,
  • "showAllVersions": true,
  • "_links": {
    },
  • "_actions": {
    },
  • "azureArchiveRetrievalPolicy": "StandardPriority"
}
Get Data Retrieval Job
Returns a resource representation of a retrieval job with the specified ID.


SecurityBearer 
Request 
path Parameters
dataRetrievalId
required
string <uuid> 
Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Get Retrieval Jobs.


 
Responses 
200
OK


default
Operation failure response.


get/v8/DataRetrievals/{dataRetrievalId}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "storageType": "AzureArchive",
  • "amazonS3GlacierRetrievalPolicy": "Expedited",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "pointInTime": "2019-08-24T14:15:22Z",
  • "retrievedRestorePointId": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "organizationUniqueId": "string",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "dataState": "Retrieving",
  • "lastStatus": "Stopped",
  • "startTime": "2019-08-24T14:15:22Z",
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "enableExpirationNotification": true,
  • "expirationHoursThreshold": 0,
  • "type": "Exchange",
  • "showDeleted": true,
  • "showAllVersions": true,
  • "_links": {
    },
  • "_actions": {
    },
  • "azureArchiveRetrievalPolicy": "StandardPriority"
}
Edit Data Retrieval Job Settings
Modifies settings of a retrieval job with the specified ID.


x-codegen-request-body-name:  dataRetrievalUpdateFromClient
SecurityBearer 
Request 
path Parameters
dataRetrievalId
required
string <uuid> 
Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Get Retrieval Jobs.


 
query Parameters
force
boolean
 Default:  false
Defines whether Veeam Backup for Microsoft 365 will check email notifications settings to ensure if email notifications are enabled.


 
Request Body schema: application/json
required
name
string or null
Specifies the retrieval job name.


 
description
string or null
Specifies the retrieval job description.


 
availabilityPeriodDays
integer or null <int32> 
Specifies how many days you will be able to explore and restore the retrieved data using Veeam Explorers.


 
enableExpirationNotification
boolean or null
Defines whether Veeam Backup for Microsoft 365 will send a notification by email before the retrieved data expires.


 
expirationHoursThreshold
integer or null <int32> 
Specifies how many hours should remain before the retrieved data expires to send a notification by email.  Use this property only with the enableExpirationNotification property.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/DataRetrievals/{dataRetrievalId}
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "availabilityPeriodDays": 0,
  • "enableExpirationNotification": true,
  • "expirationHoursThreshold": 0
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Mailboxes
Returns a collection of mailboxes whose backed-up data was retrieved from object storage repository by a retrieval job with the specified ID.


SecurityBearer 
Request 
path Parameters
dataRetrievalId
required
string <uuid> 
Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Get Retrieval Jobs.


 
query Parameters
limit
integer <int32> 
Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.


 
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
Responses 
200
OK


default
Operation failure response.


get/v8/DataRetrievals/{dataRetrievalId}/mailboxes
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Teams
Returns a collection of teams whose backed-up data was retrieved from object storage repository by a retrieval job with the specified ID.


SecurityBearer 
Request 
path Parameters
dataRetrievalId
required
string <uuid> 
Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Get Retrieval Jobs.


 
query Parameters
limit
integer <int32> 
Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.


 
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
Responses 
200
OK


default
Operation failure response.


get/v8/DataRetrievals/{dataRetrievalId}/teams
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Sites
Returns a collection of sites whose backed-up data was retrieved from object storage repository by a retrieval job with the specified ID.


SecurityBearer 
Request 
path Parameters
dataRetrievalId
required
string <uuid> 
Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Get Retrieval Jobs.


 
query Parameters
limit
integer <int32> 
Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.


 
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
Responses 
200
OK


default
Operation failure response.


get/v8/DataRetrievals/{dataRetrievalId}/webs
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get OneDrives
Returns a collection of OneDrives whose backed-up data was retrieved from object storage repository by a retrieval job with the specified ID.


SecurityBearer 
Request 
path Parameters
dataRetrievalId
required
string <uuid> 
Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Get Retrieval Jobs.


 
query Parameters
limit
integer <int32> 
Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.


 
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
Responses 
200
OK


default
Operation failure response.


get/v8/DataRetrievals/{dataRetrievalId}/onedrives
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Create Restore Session
Creates and starts a restore session to explore and restore data from backup copies for a retrieval job with the specified ID.


Use this resource for Azure Blob Storage Archive access tier, Amazon S3 Glacier Flexible Retrieval and Amazon S3 Glacier Deep Archive storage classes.


x-codegen-request-body-name:  exploreOptions
SecurityBearer 
Request 
path Parameters
dataRetrievalId
required
string <uuid> 
Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Get Retrieval Jobs.


 
Responses 
201
Created


default
Operation failure response.


post/v8/DataRetrievals/{dataRetrievalId}/explore
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "organization": "string",
  • "type": "Vex",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Working",
  • "result": "Success",
  • "initiatedBy": "string",
  • "details": "string",
  • "scopeName": "string",
  • "clientHost": "string",
  • "reason": "string",
  • "eTag": 0,
  • "_links": {
    }
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201