Edit

Share via

recycleBinItem: restore

Namespace: microsoft.graph

Restore recycleBinItem objects from the recycleBin of a fileStorageContainer. A recycleBinItem can be restored either by its id or using the original driveItemId as an alternate key.

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) FileStorageContainer.Selected Not available.
Delegated (personal Microsoft account) FileStorageContainer.Selected Not available.
Application FileStorageContainer.Selected Not available.

Note

In addition to Microsoft Graph permissions, your app must have the necessary container type-level permission or permissions to call this API. For more information, see container types. To learn more about container type-level permissions, see SharePoint Embedded authorization.

HTTP request

POST /storage/fileStorage/containers/{containerId}/recycleBin/items/restore

Restore a single recycleBinItem by using the driveItemId as an alternate key. If there's no matching recycleBinItem for the driveItemId, the API returns a 404 (Not Found) response.

POST https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/recycleBin/items(driveItemId='{driveItemId}')/restore

Request headers

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

Request body

If restoring by recycleBinItemId, in the request body, supply a JSON representation of the recycleBinItem objects to restore. If you are restoring by driveItemId as an alternate key, a request body is not required.

Response

If successfully restored by recycleBinItemId, this method returns a 207 Multi-Status response code and the set of restored recycleBinItem objects in the response body.

If successfully restored with driveItemId as an alternate key, this method returns a 200 OK response code with the id of the singular recycleBinItem that was restored in the response body.

Examples

Example 1: Restore a recycleBinItem

Request

The following example shows a request.

POST  https://graph.microsoft.com/v1.0/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/restore
Content-Type: application/json

{
  "ids": ["5d625d33-338c-4a77-a98a-3e287116440c", "73133853-48f2-4956-bc4a-03f8d1675042"]
}

Response

The following example shows the response.

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

HTTP/1.1 207 Multi-Status
Content-Type: application/json

{
  "value": [
    {
      "id": "5d625d33-338c-4a77-a98a-3e287116440c"
    },
    {
      "id": "73133853-48f2-4956-bc4a-03f8d1675042"
    }
  ]
}

Example 2: Restore a recycleBinItem by driveItemId as alternate key

In this example, the driveItemId is passed as a function parameter in the request URL. The response returns the corresponding id of the recycleBinItem that was restored.

Request

POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!LRJHKCBZQU2fLtv8TzUomsz-OP7yGQRNlugra1iGHqRe5fORWrrHTbh8J8O8qPmx/recycleBin/items(driveItemId='01GC3BS4QFPBCZRLJHJVEYPITEHTDBYHBH')/restore
Content-Type: application/json

Response

HTTP/1.1 200 Ok
Content-Type: application/json
{
  "id": "bf7ea563-b848-4ec8-9155-b2054564cfe4"
}

Example 3: Failure to restore recycleBinItem by driveItemId as alternate key

In this example, there is no matching recycleBinItem to correlate with the specified driveItemId. The API returns a 404 (Not Found) response.

Request

POST https://graph.microsoft.com/beta/storage/fileStorage/containers/e!JDJHKCBZTU2fLtv8TzUoksz-OP7yGQRNlugra1iGHqRe5fORWrrHTbh8J8O8qPmx/recycleBin/items(driveItemId='01jC3BS4QFPBCZRLGHJVEYPITEHTDBYHBP')/restore
Content-Type: application/json

Response

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": "NotFound",
    "message": "The requested resource could not be found."
  }
}
  • Last updated on