Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Mailbox Items Restore

The /RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items resource collection represents organization mailbox items to explore and restore and allows you to manage backed-up mailbox items.

Get Mailbox Item

Returns a resource representation of a backed-up mailbox item with the specified ID.

SecurityBearer
Request
path Parameters
restoreSessionId
required
string <uuid>

Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.

mailboxId
required
string <uuid>

Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.

itemId
required
string

Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Get Mailbox Items.

Responses
200

OK

default

Operation failure response.

get/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}
Request samples 
Response samples 
application/json
{
  • "mailboxId": "f16f762c-c61b-441d-8b9c-9aff4650cbe1",
  • "attachments": [
    ],
  • "organizer": "string",
  • "attendees": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "subject": "string",
  • "recurrencePatternFormat": "string",
  • "recurring": true,
  • "itemClass": "string",
  • "_links": {
    },
  • "_actions": {
    },
  • "id": "string",
  • "name": "string",
  • "address": "string",
  • "businessPhone": "string",
  • "company": "string",
  • "displayAs": "string",
  • "email": "string",
  • "fax": "string",
  • "fileAs": "string",
  • "fullName": "string",
  • "homePhone": "string",
  • "imAddress": "string",
  • "jobTitle": "string",
  • "mobile": "string",
  • "webPage": "string",
  • "from": "string",
  • "postedOn": "2019-08-24T14:15:22Z",
  • "importance": "Low",
  • "cc": "string",
  • "bcc": "string",
  • "to": "string",
  • "sent": "2019-08-24T14:15:22Z",
  • "received": "2019-08-24T14:15:22Z",
  • "reminder": true,
  • "duration": 0,
  • "entryType": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "status": "NotStarted",
  • "percentComplete": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "owner": "string"
}
Get Mailbox Items
Returns a collection of organization mailbox items to explore and restore.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


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


 
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.


 
parentId
string
Specifies what information the server will return in the resource representation. The following values are available: 
     
  • <parentID> - ID of the mailbox item. In the response, the server will return a representation of subordinates for the specified mailbox item.
    •  
  • root - specifies that the server will return a representation of all top-level items of the mailbox without their subordinates.
    •  
 If you do not specify this parameter, the server will return a representation of all top-level items of the mailbox and their subordinates. Thus, the server will require longer time to execute the request.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Restore Mailbox Items to Original Mailbox
Restores backed-up items to the original mailbox.


x-codegen-request-body-name:  restoreOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
Request Body schema: application/json
required
userName
string
Specifies the user name that you want to use for authenticating to the Exchange organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
impersonationAccountName
string
Specifies a user name of the account that will be used as a Microsoft Exchange account to restore backed-up mailbox items.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property.


 
Array of objects (RESTExchangeItemStringId) 
Specifies IDs of the mailbox items that you want to restore. For more information on how to get such IDs, see Get Mailbox Items.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/restore
Request samples 
application/json
{
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "impersonationAccountName": "string",
  • "items": [
    ]
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore Mailbox Items to Another Mailbox
Restores backed-up items to another mailbox.


x-codegen-request-body-name:  restoreOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
Request Body schema: application/json
required
changedItems
boolean or null
Defines whether all versions of mailbox items will be restored.


 
deletedItems
boolean or null
Defines whether the deleted mailbox items will be restored.


 
markRestoredAsUnread
boolean or null
Defines whether the restored mailbox items will be marked as unread.


 
excludeDrafts
boolean or null
Defines whether the Drafts mailbox folder will not be restored.


 
excludeDeletedItems
boolean or null
Defines whether the Deleted Items mailbox folder will not be restored.


 
excludeInPlaceHoldItems
boolean or null
Defines whether the preserved items of mailboxes placed on In-Place Hold will not be restored.


 
excludeLitigationHoldItems
boolean or null
Defines whether the preserved items of mailboxes placed on Litigation Hold will not be restored.


 
mailbox
string
Specifies the email address of the mailbox to which you want to restore mailbox items.


 
casServer
string
Specifies the Microsoft Exchange server with Client Access Server (CAS) role. The mailbox items will be restored to a specified mailbox server.


 
folder
string
Specifies the folder to which you want to restore mailbox items.


 
officeRegion
string or null
Specifies the region of the target Exchange organization.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
officeOrganizationName
string
Specifies the name of the target Exchange organization.


 
userName
string
Specifies the user name that you want to use for authenticating to the Exchange organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
impersonationAccountName
string
Specifies a user name of the account that will be used as a Microsoft Exchange account to restore backed-up mailbox items.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property.


 
Array of objects (RESTExchangeItemStringId) 
Specifies IDs of the mailbox items that you want to restore. For more information on how to get such IDs, see Get Mailbox Items.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/restoreTo
Request samples 
application/json
{
  • "changedItems": true,
  • "deletedItems": true,
  • "markRestoredAsUnread": true,
  • "excludeDrafts": true,
  • "excludeDeletedItems": true,
  • "excludeInPlaceHoldItems": true,
  • "excludeLitigationHoldItems": true,
  • "mailbox": "string",
  • "casServer": "string",
  • "folder": "string",
  • "officeRegion": "Worldwide",
  • "officeOrganizationName": "string",
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "impersonationAccountName": "string",
  • "items": [
    ]
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Export Mailbox Items
Exports backed-up items to a PST file. 
IMPORTANT 
 To export data to PST (Personal Storage Table) files, you must have a 64-bit version of Microsoft Outlook 2016, Microsoft Outlook 2013 or Microsoft Outlook 2010 installed on a computer running restore sessions. 

The backed-up data will be exported to a PST file and placed in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the PST file will be transferred as application/octet-stream media to the client. To download, read, convert to PST or perform other actions with the octet-stream, use features of programming languages.


If the size of the exported data exceeds the limit specified for the PST file, Veeam Backup for Microsoft 365 splits the PST file into separate files and exports these files to an archive file of the ZIP format. For example, you specified 1 GB as the PST file size limit. The size of the exported data is 1.5 GB. In this case, Veeam Backup for Microsoft 365 will export data to a ZIP archive. The archive will contain two PST files: one PST file of the 1 GB size and another PST file of the 0.5 GB size.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download the file from the temporary folder.


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
Request Body schema: application/json
required
Array of objects (RESTExchangeItemStringId) 
Specifies IDs of the mailbox items that you want to export. For more information on how to get such IDs, see Get Mailbox Items.


 
enablePstSizeLimit
boolean or null
Defines whether to set the size limit for the exported PST file. If set to true, indicates that you must specify the pstSizeLimitBytes property.


 
pstSizeLimitBytes
integer or null <int64> 
Specifies the limit of the exported PST file in Bytes. You can specify the limit range from 1 GB to 49 GB.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/exportToPst
Request samples 
application/json
{
  • "items": [
    ],
  • "enablePstSizeLimit": true,
  • "pstSizeLimitBytes": 0
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save Mailbox Items
Saves backed-up items to MSG files (Outlook Message Files).


When you save backed-up items, the request command saves the items to MSG files and transfers them to application/octet-stream media.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download files from the temporary folder.


x-codegen-request-body-name:  saveToMsgOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
Request Body schema: application/json
required
Array of objects (RESTExchangeItemStringId) 
Specifies IDs of the mailbox items that you want to save. For more information on how to get such IDs, see Get Mailbox Items.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/Save
Request samples 
application/json
{
  • "items": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send Mailbox Items to Original Mailbox
Sends backed-up items as attachments in an email message to the original mailbox. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft Exchange email settings. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  sendOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
Request Body schema: application/json
required
Array of objects (RESTExchangeItemStringId) 
Specifies IDs of the mailbox items that you want to send. For more information on how to get such IDs, see Get Mailbox Items.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/sendToDefaultAddress
Request samples 
application/json
{
  • "items": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send Mailbox Items to Another Mailbox
Sends backed-up items as attachments in an email message to a specified email address. 
NOTE 
 If you omit the from property, the default from email address specified in Veeam Explorer for Microsoft Exchange email settings will be used. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  sendOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
Request Body schema: application/json
required
Array of objects (RESTExchangeItemStringId) 
Specifies IDs of the mailbox items that you want to send. For more information on how to get such IDs, see Get Mailbox Items.


 
from
string
Specifies the email address from which the attachments will be sent.


 
to
string
Specifies the email address to which the attachments will be sent.


 
subject
string
Specifies the subject of the email message used for sending the attachments.


 
text
string
Specifies the body of the email message used for sending the attachments.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/sendToDifferentAddress
Request samples 
application/json
{
  • "items": [
    ],
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Restore Mailbox Item to Original Mailbox
Restores a backed-up item with the specified ID to the original mailbox.


x-codegen-request-body-name:  restoreOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
itemId
required
string
Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Get Mailbox Items.


 
Request Body schema: application/json
required
userName
string
Specifies the user name that you want to use for authenticating to the Exchange organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
impersonationAccountName
string
Specifies a user name of the account that will be used as a Microsoft Exchange account to restore data.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/restore
Request samples 
application/json
{
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "impersonationAccountName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore Mailbox Item to Another Mailbox
Restores a backed-up item with the specified ID to another mailbox.


x-codegen-request-body-name:  restoreOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
itemId
required
string
Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Get Mailbox Items.


 
Request Body schema: application/json
required
changedItems
boolean or null
Defines whether all versions of mailbox items will be restored.


 
deletedItems
boolean or null
Defines whether the deleted mailbox items will be restored.


 
markRestoredAsUnread
boolean or null
Defines whether the restored mailbox data will be marked as unread.


 
excludeDrafts
boolean or null
Defines whether the Drafts mailbox folder will not be restored.


 
excludeDeletedItems
boolean or null
Defines whether the Deleted Items mailbox folder will not be restored.


 
excludeInPlaceHoldItems
boolean or null
Defines whether the preserved items placed on In-Place Hold will not be restored.


 
excludeLitigationHoldItems
boolean or null
Defines whether the preserved items placed on Litigation Hold will not be restored.


 
mailbox
string
Specifies the email address of the mailbox to which you want to restore data.


 
casServer
string
Specifies the Microsoft Exchange server with Client Access Server (CAS) role. Data will be restored to a specified mailbox server.


 
folder
string
Specifies the mailbox folder to which you want to restore data.


 
officeRegion
string or null
Specifies the region of the target Exchange organization.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
officeOrganizationName
string
Specifies the name of the target Exchange organization.


 
userName
string
Specifies the user name that you want to use for authenticating to the Exchange organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
impersonationAccountName
string
Specifies a user name of the account that will be used as a Microsoft Exchange account to restore data.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/restoreTo
Request samples 
application/json
{
  • "changedItems": true,
  • "deletedItems": true,
  • "markRestoredAsUnread": true,
  • "excludeDrafts": true,
  • "excludeDeletedItems": true,
  • "excludeInPlaceHoldItems": true,
  • "excludeLitigationHoldItems": true,
  • "mailbox": "string",
  • "casServer": "string",
  • "folder": "string",
  • "officeRegion": "Worldwide",
  • "officeOrganizationName": "string",
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "impersonationAccountName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Export Mailbox Item
Exports a backed-up item with the specified ID to a PST file. 
IMPORTANT 
 To export data to PST (Personal Storage Table) files, you must have a 64-bit version of Microsoft Outlook 2016, Microsoft Outlook 2013 or Microsoft Outlook 2010 installed on a computer running restore sessions. 

The request command will export a backed-up item to a PST file and place it in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the PST file will be transferred as application/octet-stream media to the client. To download, read, convert to PST or perform other actions with the octet-stream, use features of programming languages.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download the file from the temporary folder.


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
itemId
required
string
Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Get Mailbox Items.


 
Request Body schema: application/json
required
enablePstSizeLimit
boolean or null
Defines whether to set the size limit for the exported PST file. If set to true, indicates that you must specify the pstSizeLimitBytes property.


 
pstSizeLimitBytes
integer or null <int64> 
Specifies the limit of the exported PST file in Bytes. You can specify the limit range from 1 GB to 49 GB.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/exportToPst
Request samples 
application/json
{
  • "enablePstSizeLimit": true,
  • "pstSizeLimitBytes": 0
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save Mailbox Item
Saves a backed-up item with the specified ID to a file in the MSG format (Outlook Message File).


When you save a backed-up item, the request command saves the item to a file in the MSG format and transfers it to application/octet-stream media.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download the file from the temporary folder.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
itemId
required
string
Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Get Mailbox Items.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/save
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send Mailbox Item to Original Mailbox
Sends a backed-up item with the specified ID as an attachment in an email message to the original mailbox. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft Exchange email settings. For more information, see Edit Email Settings. 


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
itemId
required
string
Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Get Mailbox Items.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/sendToDefaultAddress
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send Mailbox Item to Another Mailbox
Sends a backed-up mailbox item with the specified ID as an attachment in an email message to a specified email address. 
NOTE 
 If you omit the from property, the default from email address specified in Veeam Explorer for Microsoft Exchange email settings will be used. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  sendToMsgOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
itemId
required
string
Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Get Mailbox Items.


 
Request Body schema: application/json
required
from
string
Specifies the email address from which the attachments will be sent.


 
to
string
Specifies the email address to which the attachments will be sent.


 
subject
string
Specifies the subject of the email message used for sending the attachments.


 
text
string
Specifies the body of the email message used for sending the attachments.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/{itemId}/sendToDifferentAddress
Request samples 
application/json
{
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Restore Mailbox Items by Restore Operator
Restores backed-up mailbox items using Restore Portal. For more information about Restore Portal, see the Data Restore Using Restore Portal section of the Veeam Backup for Microsoft 365 User Guide. 
NOTE 
 You must create a restore session for a restore operator. For more information, see Create Restore Session for Restore Operator. 


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
mailboxId
required
string <uuid> 
Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailboxes.


 
Request Body schema: application/json
required
changedItems
boolean
Defines whether all versions of mailbox items will be restored.


 
deletedItems
boolean
Defines whether the deleted mailbox items will be restored.


 
markRestoredAsUnread
boolean
Defines whether the restored mailbox items will be marked as unread.


 
folder
string
Specifies the folder to which you want to restore mailbox items.


 
Array of objects (RESTExchangeItemStringId) 
Specifies IDs of the mailbox items that you want to restore. For more information on how to get such IDs, see Get Mailbox Items.


 
reason
string
Specifies a reason for the restore operation.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/operatorRestore
Request samples 
application/json
{
  • "changedItems": true,
  • "deletedItems": true,
  • "markRestoredAsUnread": true,
  • "folder": "string",
  • "items": [
    ],
  • "reason": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}

    
    

                                

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