This is an archive version of the document. To get the most up-to-date information, see the current version.Creating Restore Session for Organization
You can start a restore session to explore and restore data of an 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 more information on how to obtain a token, see Authorization and Security.
For organizations with modern app-only authentication, obtain a token using an assertion obtained from Microsoft Azure. For more information, see Authorization for Organizations with Modern App-Only Authentication.
Request
POST https://<hostname>:4443/v5/Organization/action |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
To start a restore session, the request body must contain the explore action property:
Property | Type | Description |
|---|---|---|
datetime | UTC | Specifies the date and time. You can specify the date and the time in one of the following formats:
|
type | sessionType | Specifies the type of the restore session to start:
|
showDeleted | boolean | Specifies the restore session will show the deleted items. |
showAllVersions | boolean | Specifies the restore session will show all versions of backed-up items. |
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.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 201 Created.
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: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a resource representation of the /Organization/action resource.
Examples
Example 1
Request: POST https://abc.tech.local:4443/v5/Organization/action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "explore": { "datetime": "2020-05-29T10:29:05.5413083Z", "type": "vex", "showAllVersions": false, "showDeleted": false } }
Response: 201 Created
Response Body: { "id": "a7f96a33-06cc-44a7-8219-5d1d16214184", "name": "Exchange restore (Entire organization - 5/29/2019 10:29:05 AM)", "organization": "abc.onmicrosoft.com", "type": "Vex", "creationTime": "2020-05-29T10:57:04.7961591Z", "endTime": "2020-05-29T10:57:04.7961591Z", "state": "Working", "result": "Success", "initiatedBy": "administrator.onmicrosoft.com", "_links": { "self": {"href": "https://abc.tech.local:4443/v5/RestoreSessions/a7f96a33-06cc-44a7-8219-5d1d16214184"}, "organization": {"href": "https://abc.tech.local:4443/v5/RestoreSessions/a7f96a33-06cc-44a7-8219-5d1d16214184/organization"}, "restoreSessionEvents": {"href": "https://abc.tech.local:4443/v5/RestoreSessions/a7f96a33-06cc-44a7-8219-5d1d16214184/events"} } } |