Create exchangeRestoreSession

Namespace: microsoft.graph

Create a new exchangeRestoreSession object.

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.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	BackupRestore-Restore.ReadWrite.All	Not available.

HTTP request

POST /solutions/backupRestore/exchangeRestoreSessions

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 exchangeRestoreSession.

You can specify the following properties when you create an exchangeRestoreSession object.

Property	Type	Description
granularMailboxRestoreArtifact	granularMailboxRestoreArtifact collection	Collection of granularMailboxRestoreArtifact objects.
mailboxRestoreArtifacts	mailboxRestoreArtifact collection	Collection of mailboxRestoreArtifact objects.
policyId	String	The identifier of the protection policy that scopes the restore session. The service validates that the referenced protection units belong to this policy. Optional. Inherited from restoreSessionBase.

Response

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

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

Examples

Example 1: Create exchangeRestoreSession with mailboxRestoreArtifacts

Request

The following example shows a request.

POST https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeRestoreSessions
Content-Type: application/json

{
  "policyId": "99999999-aaaa-bbbb-cccc-dddddddddddd",
  "mailboxRestoreArtifacts": [
    {
      "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#exchangeRestoreSessions/$entity",
  "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
  "status": "draft",
  "restoreJobType": "standard",
  "policyId": "99999999-aaaa-bbbb-cccc-dddddddddddd",
  "restoreSessionArtifactCount": {
    "total": 2,
    "completed": 0,
    "inProgress": 0,
    "failed": 0
  },
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "ABC"
    }
  },
  "createdDateTime": "2023-03-30T12:01:03.45Z",
  "lastModifiedBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "DEF"
    }
  },
  "lastModifiedDateTime": "2023-03-30T12:01:03.45Z",
  "error": null
}

Example 2: Create exchangeRestoreSession with granularMailboxRestoreArtifact

Request

The following example shows a request.

POST https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeRestoreSessions
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.exchangeRestoreSession",
  "granularMailboxRestoreArtifacts": [
    {
      "restorePoint": { "id": "1f1fccc3-a642-4f61-bf49-f37b9a888279" },
      "destinationType": "inPlace",
      "searchResponseId" : "M2UyZDAwMDAwMDMxMzkzYTMyNj"
    }
  ]
}

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#exchangeRestoreSessions/$entity",
  "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
  "status": "draft",
  "restoreJobType": "standard",
  "restoreSessionArtifactCount": {
    "total": 2,
    "completed": 0,
    "inProgress": 0,
    "failed": 0
  },
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "ABC"
    }
  },
  "createdDateTime": "2023-03-30T12:01:03.45Z",
  "lastModifiedBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "DEF"
    }
  },
  "lastModifiedDateTime": "2023-03-30T12:01:03.45Z",
  "error": null,
  "granularMailboxRestoreArtifact": [
    {
      "id": "959ba739-70b5-43c4-8c90-b2c22014f18a",
      "restorePoint": { "id": "1f1fccc3-a642-4f61-bf49-f37b9a888279" },
      "restoredFolderId": null,
      "status": "added",
      "startDateTime": null,
      "destinationType": "inPlace",
      "searchResponseId": "M2UyZDAwMDAwMDMxMzkzYTMyNj",
      "error": null
    }
  ]
}