Getting Restore Points

You can get a resource representation of a restore point with the specified ID.

Request

GET https://<hostname>:4443/v6/RestorePoints/{restorePointId}

Request Headers

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

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

restorePointId

string

Specifies the identification number of the restore point. For more information on how to get this parameter, see Getting Restore Points.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

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

The response body contains the following properties:

Property

Type

Description

id

string

Specifies the restore point ID.

repositoryId

string

Specifies the backup repository ID.

backupTime

UTC

Specifies the date and time when the restore point was created.

jobId

string

Specifies the backup job ID.

retrievalId

string

Specifies the data retrieval job ID.

organizationId

string

Specifies the Microsoft 365 organization ID.

isExchange

boolean

Defines whether the restore point contains Microsoft Exchange data.

isSharePoint

boolean

Defines whether the restore point contains Microsoft SharePoint data.

isOneDrive

boolean

Defines whether the restore point contains Microsoft OneDrive data.

isTeams

boolean

Defines whether the restore point contains Microsoft Teams data.

isLongTermCopy

boolean

Defines whether the the restore point was created by a backup copy job in an object storage repository.

isRetrieved

boolean

Defines whether the restore point was retrieved from an object storage repository by a data retrieval job.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example returns a resource representation of the restore point with the ID 5f7c94d0-c339-46f1-9b0f-2b9763ba83de31e4e204-7ce3-48f6-8c87-4a17f5da7e07.

Request:

GET https://abc.tech.local:4443/v6/RestorePoints/5f7c94d0-c339-46f1-9b0f-2b9763ba83de31e4e204-7ce3-48f6-8c87-4a17f5da7e07

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "id": "5f7c94d0-c339-46f1-9b0f-2b9763ba83de31e4e204-7ce3-48f6-8c87-4a17f5da7e07",

 "repositoryId": "5f7c94d0-c339-46f1-9b0f-2b9763ba83de",

 "backupTime": "2022-02-22T14:44:22.3764709Z",

 "jobId": "b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504",

 "retrievalId": "00000000-0000-0000-0000-000000000000",

 "organizationId": "e60dfb9c-ac58-4463-879f-9855ac35576b",

 "isExchange": false,

 "isSharePoint": true,

 "isOneDrive": false,

 "isTeams": false,

 "isLongTermCopy": false,

 "isRetrieved": false,

 "_links": {

   "self": {

     "href": "/v6/restorePoints/5f7c94d0-c339-46f1-9b0f-2b9763ba83de31e4e204-7ce3-48f6-8c87-4a17f5da7e07"

   },

   "organization": {

     "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

   },

   "backupRepository": {

     "href": "/v6/backuprepositories/5f7c94d0-c339-46f1-9b0f-2b9763ba83de"

   }

 }

}