Namespace: microsoft.graph
Restore a driveItem that has been deleted and is currently in the recycle bin.
Important
This functionality is currently only available for OneDrive Personal.
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) |
Not supported. |
Not supported. |
| Delegated (personal Microsoft account) |
Files.ReadWrite.All |
Not available. |
| Application |
Files.ReadWrite.All |
Not available. |
HTTP request
POST /me/drive/items/{item-id}/restore
Request body
In the request body, provide a JSON object with the following parameters.
| Parameter |
Type |
Description |
| parentReference |
ItemReference |
Optional. Reference to the parent item the deleted item will be restored to. |
| name |
String |
Optional. The new name for the restored item. If this isn't provided, the same name will be used as the original. |
Response
If successful, this method returns a 200 OK response code and the restored driveItem object in the response body.
Examples
The following example shows how to call this API.
Request
The following example shows a request.
POST https://graph.microsoft.com/v1.0/me/drive/items/{item-id}/restore
Content-type: application/json
{
"parentReference": {
"id": "String",
},
"name": "String"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Drives.Item.Items.Item.Restore;
using Microsoft.Graph.Models;
var requestBody = new RestorePostRequestBody
{
ParentReference = new ItemReference
{
Id = "String",
},
Name = "String",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].Restore.PostAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphdrives "github.com/microsoftgraph/msgraph-sdk-go/drives"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphdrives.NewRestorePostRequestBody()
parentReference := graphmodels.NewItemReference()
id := "String"
parentReference.SetId(&id)
requestBody.SetParentReference(parentReference)
name := "String"
requestBody.SetName(&name)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
restore, err := graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").Restore().Post(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.drives.item.items.item.restore.RestorePostRequestBody restorePostRequestBody = new com.microsoft.graph.drives.item.items.item.restore.RestorePostRequestBody();
ItemReference parentReference = new ItemReference();
parentReference.setId("String");
restorePostRequestBody.setParentReference(parentReference);
restorePostRequestBody.setName("String");
var result = graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").restore().post(restorePostRequestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const driveItem = {
parentReference: {
id: 'String',
},
name: 'String'
};
await client.api('/me/drive/items/{item-id}/restore')
.post(driveItem);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Drives\Item\Items\Item\Restore\RestorePostRequestBody;
use Microsoft\Graph\Generated\Models\ItemReference;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RestorePostRequestBody();
$parentReference = new ItemReference();
$parentReference->setId('String');
$requestBody->setParentReference($parentReference);
$requestBody->setName('String');
$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->restore()->post($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Files
$params = @{
parentReference = @{
id = "String"
}
name = "String"
}
Restore-MgDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.drives.item.items.item.restore.restore_post_request_body import RestorePostRequestBody
from msgraph.generated.models.item_reference import ItemReference
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RestorePostRequestBody(
parent_reference = ItemReference(
id = "String",
),
name = "String",
)
result = await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').restore.post(request_body)
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
{
"id": "1312abc!1231",
"name": "new-restored-item-name.txt",
"size": 19121,
"lastModifiedDateTime": "2017-12-12T10:40:59Z"
}