Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
RESTful API Reference

(POST) /RestoreSessions/Action

Starts restore sessions on the tenant side.

During a restore session Veeam Backup for Microsoft Office 365 uses Veeam Explorer for Microsoft Exchange functionality to explore and restore backups. Veeam Explorer for Microsoft Exchange must be deployed on the tenant side.

(POST) /RestoreSessions/Action Note:

Mind the following:

  • Tenants must use Exchange organization credentials for authenticating with the Veeam Backup for Microsoft Office 365 server.
  • To enable tenant authentication with Exchange organization credentials, a service provider must configure the authentication settings on the provider side. For more information, see the corresponding section of the Veeam Backup for Microsoft Office 365 User Guide at: helpcenter.veeam.com/docs/vbo365/guide/vbo_authentication.html.

Request

To start a restore session, send the POST HTTPS request to the URL of the /RestoreSessions/Action resource.

HTTPS Request

POST https://<Backup-Office365>:4443/v1/RestoreSessions/Action

Request Headers

The request header must contain the authorization token for the current logon 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 in the following format: <yyyy.MM.dd hh:mm:ss>.

For example, "datetime": "2017.08.29 18:00:00".

For example:

{

 "explore":

 {"datetime": "2017.08.29 18:00:00"

 }

}

The request command will start a restore session only for mailbox backups that were created at the time you specified.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns 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 request body message: application/json; charset=utf-8

Response Body

In the response body, the server returns a representation of the /RestoreSessions/Action resource.

The resource has the following URL: /RestoreSessions/{ID}.

Example

The example below shows how to start a restore session on the tenant side.

You will need to perform the following steps:

  1. Authenticate your access to Veeam Backup for Microsoft Office 365 RESTful API resources using Exchange organization credentials:
  • Send the POST HTTPS request to the Veeam Backup for Microsoft Office 365 token path. In the request body, enter Exchange organization credentials for authenticating with the Veeam Backup for Microsoft Office 365 server.

Request:

POST https://support.east.local:4443/v1/Token

 

Request Body:

grant_type=password&username=tech\administrator&password=PassWord1

  • The server will return a pair of access and refresh tokens in the response body. Insert an access token in the header of a further request.

Response:

200 OK

 

Response Body:

{

 "access_token":"AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAA5Ck8ocJ100Wyxh8hdKuiEwAAAAACAAAAAAAQZgAAAAEAACAAAABHCQCYPKfpXWKw_uoeoq20pNhKX-lyip5kdBIqDhiVsQAAAAAOgAAAAAIAACAAAABGFN15MbhZZ6I93ZR3gk1PCwpX7JodpsGaiXN2dXXlnsAAAACR9Ex4dJi6FQx6TL4_qJnn6UhGYoOcRboeojjMdLXnuce6wDr2_3aUfaJEpts0FUdrF_vZLSs7S_9pgtQJ1-ZrsjW4lomnLRdaN-EhCiLHKQ3N2cOylnNPv9Ycwrao5HDgT3ydfHF8BrMuCsvluuqizSSBGZyWRJmJbfyaSFQaVnxpqHlJCCSyogNLdmQGLKM-LmcBxsRvNP1qsRLRDeHniu9gyXWcpnZMjtOIpjkKCt603zl-4ha3H2wzn0k4JRdAAAAALal2CIHeK4bTmTSRfTI7xgV5MTYI7LFEGJBkG-LkYZuj6YD1lTq1WuPQ_Pkmf0WKRI_mwOmSB40LyJH0uk-cjA",

 "token_type":"bearer",

 "expires_in":60,

 "refresh_token":"AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAA5Ck8ocJ100Wyxh8hdKuiEwAAAAACAAAAAAAQZgAAAAEAACAAAAAFXnoKO_LrlINdvNVDzqIeKB-opJRRyifnSGCCZN451gAAAAAOgAAAAAIAACAAAADBlvQhlBL_6WJUaOKTv2snGBxQFgr9sBDUwwvtAQx6J8AAAADQ8kWrxs7_2EpRX8pFejNzte1OSDvyU4WhyIKc7oKm5ja5KnqdVR778Ypi_fsCn4IBFbxlGFbLMDcUIRfH8UQCew3waMBYWg9WPyaMFOb0uBZTI1VAjEJEpHyehyaikKJdXOipeP8IoMVeQfLmJ-Jq_8OeLjIQSQEOqkgiImFXX2nu2HlgiXsYy9hA6t9_xek7nMY25X5_KQVobbnKBe0bkqb0OjenI3Pbrl8vgnyVem0kPsuDJtOTKnoPESzNqy9AAAAA6_NWQSQcujiwl-BWBfEZxdozsobU5H0bHWxM7WPYFdIwfjAeUIxvrpns4IXaE0z_VAnUYLOkT-ep-uiouWd_Jw",

 ".issued":"Thu, 30 August 2017 06:33:40 GMT",

 ".expires":"Fri, 30 August 2017 06:33:40 GMT"

}

  1. Start a restore session:
  • Send the POST HTTPS request to the URL of the /RestoreSessions/Action resource

Request:

POST https://support.east.local:4443/v1/RestoreSessions/Action

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

 

{

 "explore":

 {"datetime": "2017.08.29 18:00:00"

 }

}

  • In the response body, the server will return the resource representation of a restore session

Response:

201 Created

 

Response Body:

{

 {

 "id": "9234471b-c5e4-295b-1dv0-35d66115c3fz",

 "type": "Vex",

 "pointInTime": "2017-08-29T18:00:00-07:00",

 "creationTime": "2017-08-30T07:42:21.191694Z",

 "state": "Working",

 "result": "Success",

 "_links": {

   "self": {

     "href": "https://support.east.local:4443/v1/restoresessions/9234471b-c5e4-295b-1dv0-35d66115c3fz"

   },

   "organization": {

     "href": "https://support.east.local:4443/v1/restoresessions/9234471b-c5e4-295b-1dv0-35d66115c3fz/organization"

   }

 }

}

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference