Edit

Create sharePointRestoreSession

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.

Create a new sharePointRestoreSession object. To create a granular restore session, granular site restore artifacts must be present in the payload. A request can't include both granularSiteRestoreArtifact and siteRestoreArtifact in the same create or update request.

If no payload is provided when you create the restore session, the request creates an empty standard restore session by default.

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 permissions Higher privileged permissions
Delegated (work or school account) BackupRestore-Restore.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application BackupRestore-Restore.ReadWrite.All Not available.

HTTP request

POST /solutions/backupRestore/sharePointRestoreSessions

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the sharePointRestoreSession object.

You can specify the following properties when you create a sharePointRestoreSession object.

Property Type Description
@microsoft.graph.conflictBehavior String The conflict resolution behavior when restoring each granular restore artifact in a session. The possible values are: fail (default), replace, rename. Only supported for granular restore sessions. Optional.
granularSiteRestoreArtifacts granularSiteRestoreArtifact collection A collection of granularSiteRestoreArtifact objects. Required.
siteRestoreArtifacts siteRestoreArtifact collection A collection of siteRestoreArtifact objects. Required.

Response

If successful, this method returns a 201 Created response code and a sharePointRestoreSession object in the response body.

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

Examples

Example 1: Create a standard restore session

The following example shows how to create a standard restore session.

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/solutions/backupRestore/sharePointRestoreSessions
Content-Type: application/json

{
  "siteRestoreArtifacts": [
    {
      "restorePoint": { "id": "1f1fccc3-a642-4f61-bf49-f37b9a888279" },
      "destinationType": "inPlace"
    },
    {
      "restorePoint": { "id": "1f1fccc3-a642-4f61-bf49-f37b9a888280" },
      "destinationType": "inPlace"
    }
  ]
}

Response

The following example shows the response.

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": " /solutions/backupRestore/$metadata#restoreSessions/$entity",
  "@odata.id": "/solutions/backupRestore/sharepointRestoreSessions(61633878-8321-4950-bfaf-ed285bdd1461)",
  "@odata.type": "#microsoft.graph.sharepointRestoreSession",
  "id": "61633878-8321-4950-bfaf-ed285bdd1461",
  "status": "draft",
  "restoreJobType": "standard",
  "restoreSessionArtifactCount": {
    "total": 2,
    "completed": 0,
    "inProgress": 2,
    "failed": 0
  },
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User1"
    }
  },
  "createdDateTime": "2015-06-19T12:01:03.45Z",
  "lastModifiedBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User2"
    }
  },
  "lastModifiedDateTime": "2015-06-19T12:01:03.45Z"
}

Example 2: Create a granular restore session

The following example shows how to create a granular restore session.

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/solutions/backupRestore/sharePointRestoreSessions
Content-Type: application/json

{
  "granularSiteRestoreArtifacts": [
    {
      "browseSessionId": "eJxVjEEKwjAQRfc80xeIleluFd2HRkZCgAIEu9CO3aUv78W4H_q_NgQY2gSJHT8IoOhrl5AzosZGBk6",
      "id": "a535851e-9fc6-4eb1-90ab-2955fd9117b5,2a8b7eaf-092a-4561-a25a-998ad2e5142e,38eec3f1-b879-44a6-8ae6-05bd46ed4b3d,ce66019f-cdf9-4575-aa81-de3aabe844a2"
    },
    {
      "browseSessionId": "eJxVjEEKwjAQRfc80xeIleluFd2HRkZCgAIEu9CO3aUv78W4H_q_NgQY2gSJHT8IoOhrl5AzosZGBk6",
      "id": "b535851e-9fc6-4eb1-90ab-2955fd9117b5,2a8b7eaf-092a-4561-a25a-998ad2e5142e,38eec3f1-b879-44a6-8ae6-05bd46ed4b3d,ce66019f-cdf9-4575-aa81-de3aabe844a2"
    }
  ]
}

Response

The following example shows the response.

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "/solutions/backupRestore/$metadata#sharePointRestoreSessions/$entity",
  "id": "23e0638e-3ad7-4c7e-8749-72175d046e30",
  "status": "draft",
  "restoreJobType": "granular",
  "createdDateTime": "2025-06-28T15:05:54.1352557Z",
  "lastModifiedDateTime": "2025-06-28T15:05:54.4852234Z",
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User1"
    }
  },
  "lastModifiedBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User2"
    }
  },
  "restoreSessionArtifactCount": {
      "total": 2,
      "inProgress": 0,
      "completed": 0,
      "failed": 0
  }
}

Example 3: Create a granular restore session with in-place restore and conflict behavior

The following example shows how to create a granular restore session that restores artifacts in place with a specified conflict resolution behavior. The @microsoft.graph.conflictBehavior annotation applies uniformly to all artifacts in the session. If not specified, the default behavior is fail.

Note: The @microsoft.graph.conflictBehavior annotation is only supported for granular restore sessions. If specified on a non-granular session, a 400 Bad Request is returned.

Mixed destination type within a single granular restore session is not supported.

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/solutions/backupRestore/sharePointRestoreSessions
Content-Type: application/json

{
  "@microsoft.graph.conflictBehavior": "rename",
  "granularSiteRestoreArtifacts": [
    {
      "browseSessionId": "eJxVjEEKwjAQRfc80xeIleluFd2HRkZCgAIEu9CO3aUv78W4H_q_NgQY2gSJHT8IoOhrl5AzosZGBk6",
      "id": "a535851e-9fc6-4eb1-90ab-2955fd9117b5,2a8b7eaf-092a-4561-a25a-998ad2e5142e,38eec3f1-b879-44a6-8ae6-05bd46ed4b3d,ce66019f-cdf9-4575-aa81-de3aabe844a2",
      "destinationType": "inPlace"
    },
    {
      "browseSessionId": "eJxVjEEKwjAQRfc80xeIleluFd2HRkZCgAIEu9CO3aUv78W4H_q_NgQY2gSJHT8IoOhrl5AzosZGBk6",
      "id": "b535851e-9fc6-4eb1-90ab-2955fd9117b5,2a8b7eaf-092a-4561-a25a-998ad2e5142e,38eec3f1-b879-44a6-8ae6-05bd46ed4b3d,ce66019f-cdf9-4575-aa81-de3aabe844a2",
      "destinationType": "inPlace"
    }
  ]
}

Response

The following example shows the response.

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "/solutions/backupRestore/$metadata#sharePointRestoreSessions/$entity",
  "id": "23e0638e-3ad7-4c7e-8749-72175d046e30",
  "status": "draft",
  "restoreJobType": "granular",
  "createdDateTime": "2025-06-28T15:05:54.1352557Z",
  "lastModifiedDateTime": "2025-06-28T15:05:54.4852234Z",
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User1"
    }
  },
  "lastModifiedBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User2"
    }
  },
  "restoreSessionArtifactCount": {
      "total": 2,
      "inProgress": 0,
      "completed": 0,
      "failed": 0
  }
}
  • Last updated on