Creating Restore Session for Organization by Organization ID

This section explains how to start a restore session for the specified organization.

Request

POST https://<hostname>:4443/v4/Organizations/{organizationId}/Action

Request Headers

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

Request Parameters

The following parameters must be posted as URL.

Parameter

Type

Description

organizationId

string

An identification number of the organization.

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:

  • <yyyy-MM-dd HH:mm:ss.SSS>
  • <yyyy.MM.dd hh:mm:ss>

Type

sessionType

Specifies the type of the restore session to start:

  • vex
  • vesp
  • veod

ShowDeleted

boolean

Specifies the restore session will show the deleted items.

ShowAllVersions

boolean

Specifies the restore session will show all versions of the restored items.

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 /Organization/{organizationId} 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 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 representation of the /Organization/{organizationId}/Action resource.

Example

Request:

POST https://abc.tech.local:4443/v4/Organization/9b538005-3e78-4263-a876e-cc51730757de/Action

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "explore": {

  "datetime": "2019-04-12T10:54:40.2794046Z",

  "type": "vex",

  ShowAllVersions: false,

  ShowDeleted: false

 }

}

 

Response:

200 OK

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.