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

(POST) /Organizations/{ID}/Action

Starts restore sessions for exploring and performing restore operations with backups.

Request

To start a restore session, send the POST HTTPS request to the URL of the /Organizations/{ID}/Action resource.

HTTPS Request

POST https://<Backup-Office365>:4443/v2/Organizations/{ID}/Action

Request Headers

The request contains the following headers:

Header

Required

Description

Content-Type: application/json

true

Specifies the type of the content for your request.

Authorization: Bearer <Access-Token>

true

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.06.26 22:07:39".

Type

sessionType

Specifies the type of the restore session to start:

  • vex
  • vesp
  • veod

For example, "type": "vex".

The request command will start a restore session only for backups that were created at the time you specified. The firstBackuptime and lastBackuptime properties of the /Organizations/{ID} resource inform you when the organization's data was backed up for the first and last times.

Mind the following:

  • If you specify the point in time which precedes the organization's first backup time, the restore session will be created with no backup data for explore or restore.
  • If you specify the point in time which exceeds the organization's last backup time, the restore session will be created with 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 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 /Organizations/{ID}/Action resource.

Example

Request:

POST https://support.east.local:4443/v2/Organization/9b538005-3e78-4263-a876e-cc51730757de/Action

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "explore": {"datetime": "2018.05.30", "type": "vex"}

}

 

Response:

200 OK

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference