Restoring Mailbox Items by Restore Operator

In this article

    You can restore 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.

    To restore data using Restore Portal, you must create a restore session for a restore operator. For more information, see Creating Restore Session for Restore Operator.

    Request

    POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/items/operatorRestore

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameters must be specified in the URL of the request:

    Parameter

    Type

    Description

    restoreSessionId

    string

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

    mailboxId

    string

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

    Request Body

    To restore backed-up mailbox items using Restore Portal, the request body must contain the following properties:

    Property

    Type

    Description

    changedItems

    boolean

    If set to true, indicates that all versions of mailbox items will be restored.

    deletedItems

    boolean

    If set to true, indicates that deleted mailbox items will be restored.

    markrestoredAsunread

    boolean

    If set to true, indicates that restored mailbox items will be marked as unread.

    folder

    string

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

    items

    item[]

    Specifies the IDs of mailbox items that you want to restore. For more information on how to get such IDs, see Getting Mailbox Items.

    reason

    string

    Specifies a reason for the restore operation.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message for the requests with the export and save actions: application/octet-stream.

    The media type and syntax of the response body message for the requests with the restore and send actions: null.

    Response Body

    None.

    Example

    The following request restores backed-up mailbox items using Restore Portal.

    Request:

    POST https://abc.tech.local:4443/v6/RestoreSessions/380d7caf-6294-4a33-b50a-b8aeb13af58c/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/Items/operatorRestore

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

       "changedItems": true,

       "deletedItems": false,

       "markrestoredAsunread": true

       "folder": "Folder1",

       "reson": "Restore of deleted items",

       "items":  [

           {"Id": "74685f6b-16aa-4a78-a44f-05526ce0ae30"},

           {"Id": "70013a9e-c446-429d-aa78-9c8c20d9b814"}

       ]

    }

     

    Response:

    200 OK