Creating Restore Session for Tenant Organization
You can start a restore session to explore and restore data of a tenant Microsoft organization.
To use this resource, make sure to obtain a token using the same credentials that were used to add the organization instead of credentials of an administrative account. For organizations with modern app-only authentication, obtain a token using an assertion obtained from Microsoft Azure. For more information, see Authorization for Tenants.
The request header must contain an authorization token of the current session.
To start a restore session, the request body must contain the following properties:
Specifies the date and time. You can specify the date and the time in one of the following formats:
Veeam Backup for Microsoft 365 will start a restore session for data that was backed up prior to the specified date and time.
Specifies the type of the restore session to start. The following types are available:
Defines whether the restore session will show items that have been removed by the user before the specified date.
Defines whether the restore session will show all versions of items that have been modified by the user before the specified date.
The request command will start a restore session only for backups that were created at the time you have specified.
Consider the following:
- If you specify a point in time which precedes the first time the organization was backed up, the restore session will be created with no backup data for explore or restore.
- If you specify a point in time which exceeds the last time the organization was backed up, the restore session will be created with the backup data as of the latest restore point.
The server returns the following response to the client.
A successfully completed operation returns a response code 200 OK.
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
The length of the response body.
The media type and syntax of the response body message: application/json; charset=utf-8
In the response body, the server returns a resource representation of the restore session. The response body contains the following properties:
Specifies the restore session ID.
Specifies a name of the restore session.
Specifies the name of the Microsoft 365 organization.
Specifies the type of the restore session. The following types are available:
Specifies date and time when the restore session was started.
Specifies date and time when the restore session ended.
Specifies the state of the restore session. The following values are available:
Specifies the restore session result. The following values are available:
Specifies the name of the who initiated the restore session.
Specifies the restore session details.
Specifies a scope of the restore session created using Restore Portal.
Specifies a DNS name or an IP address of the Veeam Backup for Microsoft 365 server.
Specifies a reason to perform restore operation.
Dictionary of string [key] and Object [value]
Links to related resources (navigation property).
The example returns a resource representation of the restore session created for an organization.
Authorization: Bearer <Access-Token>
"name": "Exchange restore (Entire organization - 1/22/2022 2:56:55 PM)",
"clientHost": "EPSILON (via: 127.0.0.1)",