Getting Restore Points

In this article

    You can get a list of restore points created by Veeam Backup for Microsoft 365.

    Request

    GET https://<hostname>:4443/v6/RestorePoints?organizationId=<string>&jobId=<string>&repositoryId=<string>&backupTime=<UTC>&isLongTermCopy=<boolean>&isRetrieved=<boolean>

    Request Headers

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

    Request Parameters

    The following optional parameters can be specified in the URL of the request:

    Property

    Type

    Description

    organizationID

    string

    Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations.

    jobID

    string

    Specifies the identification number of the backup job that created the restore points you want to get. For more information on how to get this parameter, see Getting Backup Jobs.

    repositoryId

    string

    Specifies the identification number of the backup repository where the restore point was created. For more information on how to get this parameter, see Getting Backup Repositories.

    backupTime

    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>

    The server will return information about restore points that were created after the specified date and time.

    isLongTermCopy

    boolean

    Defines whether the the server will return information about restore points created by backup copy jobs in object storage repositories.

    isRetrieved

    boolean

    Defines whether the server will return information about restore points retrieved from object storage repositories by data retrieval jobs.

    Request Body

    None.

    Request Example

    Request:

    GET https://abc.tech.local:4443/v6/RestorePoints?organizationId=b7f43a7f-3508-4d04-8ec2-ece6944e916b

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    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

    In the response body the server returns a resource representation of the /RestorePoints collection resource.

    Example

    The example returns a resource representation of all restore points that were created under the current logon credentials.

    Request:

    GET https://abc.tech.local:4443/v6/RestorePoints

     

    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"

         }

       }

     },

     {

       "id": "79f3e494-4991-4dd5-b6fa-f1cf8c42126531e4e204-7ce3-48f6-8c87-4a17f5da7e07",

       "repositoryId": "79f3e494-4991-4dd5-b6fa-f1cf8c421265",

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

       "jobId": "1f6f7c97-0df4-4866-8c37-309fda301894",

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

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

       "isExchange": false,

       "isSharePoint": true,

       "isOneDrive": false,

       "isTeams": false,

       "isLongTermCopy": true,

       "isRetrieved": false,

       "_links": {

         "self": {

           "href": "v6/restorePoints/79f3e494-4991-4dd5-b6fa-f1cf8c42126531e4e204-7ce3-48f6-8c87-4a17f5da7e07"

         },

         "organization": {

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

         },

         "backupRepository": {

           "href": "v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265"

         }

       }

     },

     {

       "id": "5f7c94d0-c339-46f1-9b0f-2b9763ba83dead7ec842-9c23-45b6-b2b9-49903771d90f",

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

       "backupTime": "2022-02-22T14:33:58.7637276Z",

       "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-2b9763ba83dead7ec842-9c23-45b6-b2b9-49903771d90f"

         },

         "organization": {

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

         },

         "backupRepository": {

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

         }

       }

     },

     ...

     {

       "id": "79f3e494-4991-4dd5-b6fa-f1cf8c421265bc0e58d5-2bb3-41ca-ba7b-176957d4b601",

       "repositoryId": "79f3e494-4991-4dd5-b6fa-f1cf8c421265",

       "backupTime": "2022-02-22T10:41:02.5506492Z",

       "jobId": "1f6f7c97-0df4-4866-8c37-309fda301894",

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

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

       "isExchange": false,

       "isSharePoint": true,

       "isOneDrive": false,

       "isTeams": false,

       "isLongTermCopy": true,

       "isRetrieved": false,

       "_links": {

         "self": {

           "href": "v6/restorePoints/79f3e494-4991-4dd5-b6fa-f1cf8c421265bc0e58d5-2bb3-41ca-ba7b-176957d4b601"

         },

         "organization": {

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

         },

         "backupRepository": {

           "href": "v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265"

         }

       }

     }

    ]