List restorePoints

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a list of restorePoint objects and their properties.

Note: This API returns a maximum of five restorePoint objects. If you don't include the orderBy parameter, the five most recent restore points are returned.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permission	Higher privileged permissions
Delegated (work or school account)	BackupRestore-Restore.Read.All	BackupRestore-Restore.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	BackupRestore-Restore.Read.All	BackupRestore-Restore.ReadWrite.All

HTTP request

To filter the expanded protectionUnit by ID:

GET /solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq '{ProtectionUnitID}')&$filter=protectionDateTime lt YYYY-MM-DDTHH:mm:ssZ

To filter restorePoint objects by protection unit and policy:

GET /solutions/backupRestore/restorePoints?$expand=protectionUnit&$filter=protectionDateTime lt YYYY-MM-DDTHH:mm:ssZ and protectionUnit/id eq '{protectionUnitId}' and protectionUnit/policyId eq '{policyId}'

Optional query parameters

This method supports the $expand, $filter and orderBy OData query parameters, as shown in the example later in this topic.

The $expand and $filter query parameters are required.

Use $filter with lt on protectionDateTime. To filter the expanded protectionUnit by ID, use eq on id within $expand. To filter restorePoint objects by protection unit and policy, use eq on protectionUnit/id and protectionUnit/policyId and combine the expressions with and.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of restorePoint objects in the response body.

For a list of possible error responses, see Backup Storage API error responses.

Examples

Request

The following example shows a request.

HTTP

To filter the expanded protectionUnit by ID:

GET https://graph.microsoft.com/beta/solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853')&$filter=protectionDateTime lt 2024-05-12T10:01:00Z

To filter restorePoint objects by protection unit and policy:

GET https://graph.microsoft.com/beta/solutions/backupRestore/restorePoints?$expand=protectionUnit&$filter=protectionDateTime lt 2024-05-12T10:01:00Z and protectionUnit/id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853' and protectionUnit/policyId eq '9fec8e78-bce4-4aaf-ab1b-5451cc387264'

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BackupRestore.RestorePoints.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Expand = new string []{ "protectionUnit($filter=id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853')" };
	requestConfiguration.QueryParameters.Filter = "protectionDateTime lt 2024-05-12T10:01:00Z";
});

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphsolutions "github.com/microsoftgraph/msgraph-beta-sdk-go/solutions"
	  //other-imports
)


requestFilter := "protectionDateTime lt 2024-05-12T10:01:00Z"

requestParameters := &graphsolutions.BackupRestoreRestorePointsRequestBuilderGetQueryParameters{
	Expand: [] string {"protectionUnit($filter=id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853')"},
	Filter: &requestFilter,
}
configuration := &graphsolutions.BackupRestoreRestorePointsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
restorePoints, err := graphClient.Solutions().BackupRestore().RestorePoints().Get(context.Background(), configuration)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

RestorePointCollectionResponse result = graphClient.solutions().backupRestore().restorePoints().get(requestConfiguration -> {
	requestConfiguration.queryParameters.expand = new String []{"protectionUnit($filter=id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853')"};
	requestConfiguration.queryParameters.filter = "protectionDateTime lt 2024-05-12T10:01:00Z";
});

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let restorePoints = await client.api('/solutions/backupRestore/restorePoints')
	.version('beta')
	.filter('protectionDateTime lt 2024-05-12T10:01:00Z')
	.expand('protectionUnit($filter=id eq \'d234cf54-e0fb-49b7-9c8a-5bcd1439e853\')')
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Solutions\BackupRestore\RestorePoints\RestorePointsRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new RestorePointsRequestBuilderGetRequestConfiguration();
$queryParameters = RestorePointsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->expand = ["protectionUnit(\$filter=id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853')"];
$queryParameters->filter = "protectionDateTime lt 2024-05-12T10:01:00Z";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->solutions()->backupRestore()->restorePoints()->get($requestConfiguration)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Beta.BackupRestore

Get-MgBetaSolutionBackupRestorePoint -ExpandProperty "protectionUnit(`$filter=id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853')" -Filter "protectionDateTime lt 2024-05-12T10:01:00Z" 

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.solutions.backup_restore.restore_points.restore_points_request_builder import RestorePointsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = RestorePointsRequestBuilder.RestorePointsRequestBuilderGetQueryParameters(
		expand = ["protectionUnit($filter=id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853')"],
		filter = "protectionDateTime lt 2024-05-12T10:01:00Z",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.solutions.backup_restore.restore_points.get(request_configuration = request_configuration)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "/solutions/backupRestore/restorePoints",
  "@odata.nextLink": "https://graph.microsoft.com/beta/solutions/backupRestore/restorePoints?$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0k2NDUwOTgzMg%3d%3d",
  "value": [
    {
      "@odata.type": "#microsoft.graph.restorePoint",
      "id": "cdf4a823-sfde-ki2s-kmsj-clu2nsdkk2as",
      "protectionDateTime": "2023-01-01T00:00:00Z",
      "expirationDateTime": "2024-01-01T00:00:00Z",
      "protectionUnit": {
        "@odata.type": "#microsoft.graph.siteProtectionUnit",
        "id": "32514d8c-71fe-4d00-a01a-31850bc5b32c",
        "siteId": "contoso-jpn.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e851852",
        "policyId": "9fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "tags": "fastRestore" // Newly Added
    },
    {
      "@odata.type": "#microsoft.graph.restorePoint",
      "id": "cdf4a823-sfde-ki2s-kmsj-clu2nsdk43as",
      "protectionDateTime": "2023-01-01T00:00:00Z",
      "expirationDateTime": "2024-01-01T00:00:00Z",
      "protectionUnit": {
        "@odata.type": "#microsoft.graph.siteProtectionUnit",
        "id": "17014d8c-71fe-4d00-a01a-31850bc5b32c",
        "siteId": "contoso-jpn.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e851861",
        "policyId": "9fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "tags": "fastRestore" // Newly Added
    },
    {
      "@odata.type": "#microsoft.graph.restorePoint",
      "id": "cdf4a823-sfde-ki2s-kmsj-clu2nsdk43ga",
      "protectionDateTime": "2023-01-07T00:00:00Z",
      "expirationDateTime": "2024-01-07T00:00:00Z",
      "protectionUnit": {
        "@odata.type": "#microsoft.graph.siteProtectionUnit",
        "id": "23014d8c-71fe-4d00-a01a-31850bc5b42a",
        "siteId": "contoso-jpn.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e857893",
        "policyId": "9fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "tags": "fastRestore" // Newly Added
    }
  ]
}