Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Restore Sessions

This set of endpoints represents restore sessions and allows you to manage them as well as to create a restore session for a tenant Microsoft organization or for a restore operator.

Get Restore Sessions

Returns a collection of restore sessions.

SecurityBearer
Request
query Parameters
limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

startTimeFrom
string

Specifies the start of the time period used to filter restore sessions by the session start time. In the response, the server will return restore sessions that started after the specified time.

startTimeTo
string

Specifies the end of the time period used to filter restore sessions by the session start time. In the response, the server will return restore sessions that started prior to the specified time.

endTimeFrom
string

Specifies the start of the time period used to filter restore sessions by the session end time. In the response, the server will return restore sessions that finished after the specified time.

endTimeTo
string

Specifies the end of the time period used to filter restore sessions by the session end time. In the response, the server will return restore sessions that finished prior to the specified time.

orderAsc
boolean

Defines whether the date and time are specified in ascending order. The default value is false.

orderBy
string

Defines how restore sessions will be sorted. The default value is CreationTime.

Enum: "CreationTime" "EndTime"
Responses
200

OK

default

Operation failure response.

get/v8/RestoreSessions
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Restore Session
Returns a resource representation of a restore session with the specified ID.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "organization": "string",
  • "type": "Vex",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Working",
  • "result": "Success",
  • "initiatedBy": "string",
  • "details": "string",
  • "scopeName": "string",
  • "clientHost": "string",
  • "reason": "string",
  • "eTag": 0,
  • "_links": {
    }
}
Stop Restore Session
Stops a restore session with the specified ID.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Stop
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Restore Session Statistics
Returns statistics for a restore session with the specified ID.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Statistics
Request samples 
Response samples 
application/json
{
  • "totalItemsCount": 0,
  • "restoredItemsCount": 0,
  • "failedItemsCount": 0,
  • "skippedItemsCount": 0,
  • "warnings": [
    ],
  • "errors": [
    ],
  • "items": [
    ]
}
Get Device Code
Allows you to obtain a device code from Microsoft Identity platform to restore data of Microsoft 365 organizations added using modern app-only authentication.


x-codegen-request-body-name:  requestOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
Request Body schema: application/json
required
targetApplicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for data restore.


 
targetRegion
string or null
Specifies a region of the Microsoft 365 organization that contains data you want to restore.


Note: This property is only required when planning to restore to a custom location.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
targetOrganizationName
string
Specifies a name of the Microsoft 365 organization to which you want to restore data.


Note: This property is only required when planning to restore to a custom location.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/restoreDeviceCode
Request samples 
application/json
{
  • "targetApplicationId": "00000000-0000-0000-0000-000000000000",
  • "targetRegion": "Worldwide",
  • "targetOrganizationName": "string"
}
Response samples 
application/json
{
  • "userCode": "string",
  • "verificationUrl": "string",
  • "expiresIn": 0,
  • "message": "string"
}
Create Restore Session for Tenant Organization
Creates and starts 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 Identity platform. For more information, see the Veeam Backup for Microsoft 365 REST API Reference, section Authorization for Tenants.


x-codegen-request-body-name:  exploreOptions
SecurityBearer 
Request 
Request Body schema: application/json
required
dateTime
string or null <date-time> 
Specifies the date and time.


 
type
string or null
Specifies a type of the restore session to start.


 Enum: "Vex" "Veod" "Vesp" "Vet"  
showDeleted
boolean or null
Defines whether the restore session will show items that have been removed by the user before the specified date.


 
showAllVersions
boolean or null
Defines whether the restore session will show all versions of items that have been modified by the user before the specified date.


 
Responses 
201
Created


default
Operation failure response.


post/v8/Organization/Explore
Request samples 
application/json
{
  • "dateTime": "2019-08-24T14:15:22Z",
  • "type": "Vex",
  • "showDeleted": true,
  • "showAllVersions": true
}
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "organization": "string",
  • "type": "Vex",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Working",
  • "result": "Success",
  • "initiatedBy": "string",
  • "details": "string",
  • "scopeName": "string",
  • "clientHost": "string",
  • "reason": "string",
  • "eTag": 0,
  • "_links": {
    }
}
Create Restore Session for Restore Operator
Creates and starts a restore session to explore and restore data using Restore Portal.


To use this resource, make sure to obtain a token using an assertion obtained from Microsoft Identity platform and log in to Veeam Backup for Microsoft 365 REST API as a restore operator. For more information, see the Veeam Backup for Microsoft 365 REST API Reference, section Authorization for Restore Operators.


x-codegen-request-body-name:  exploreOptions
SecurityBearer 
Request 
Request Body schema: application/json
required
dateTime
string or null <date-time> 
Specifies the date and time.


 
type
string or null
Specifies a type of the restore session to start.


 Enum: "Vex" "Veod" "Vesp" "Vet"  
showDeleted
boolean or null
Defines whether the restore session will show items that have been removed by the user before the specified date.


 
showAllVersions
boolean or null
Defines whether the restore session will show all versions of items that have been modified by the user before the specified date.


 
object (RESTRbacItemComposed) 
 
x-anyOf:  [{"$ref":"#/components/schemas/RESTRbacUserItem"},{"$ref":"#/components/schemas/RESTRbacSiteItem"},{"$ref":"#/components/schemas/RESTRbacGroupItem"},{"$ref":"#/components/schemas/RESTRbacTeamItem"}]
repositoryId
string or null <uuid> 
Specifies the backup repository ID.


 
reason
string
Specifies a reason for the restore operation.


 
Responses 
201
Created


default
Operation failure response.


post/v8/Organization/OperatorExplore
Request samples 
application/json
{
  • "dateTime": "2019-08-24T14:15:22Z",
  • "type": "Vex",
  • "showDeleted": true,
  • "showAllVersions": true,
  • "scope": {
    },
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "reason": "string"
}
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "organization": "string",
  • "type": "Vex",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Working",
  • "result": "Success",
  • "initiatedBy": "string",
  • "details": "string",
  • "scopeName": "string",
  • "clientHost": "string",
  • "reason": "string",
  • "eTag": 0,
  • "_links": {
    }
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201