Saving OneDrive Documents
You can save backed-up OneDrive documents.
OneDrive documents are always saved in a ZIP archive. When you save backed-up OneDrive documents, the request command archives the documents and places the ZIP archive a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the archive is transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.
|
You can use Swagger UI to download data from the stream by clicking the Download action link in the response body. For more information, see Evaluation in Swagger UI. |
Request
POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/save |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
restoreSessionId | string | Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions. |
oneDriveId | string | Specifies the identification number of OneDrive. For more information on how to get this parameter, see Getting OneDrives. |
Request Body
To save backed-up OneDrive documents, the request body must contain the following property:
Property | Type | Description |
|---|---|---|
documents | document[] | Specifies the IDs of OneDrive documents that you want to save. For more information on how to get such IDs, see Getting OneDrive Documents. |
For example:
Request Body: { "documents": [ {"id": "74685f6b-16aa-4a78-a44f-05526ce0ae30"}, {"id": "70013a9e-c446-429d-aa78-9c8c20d9b814"} ] } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message for the requests with the export and save actions: application/octet-stream. The media type and syntax of the response body message for the requests with the restore and send actions: null. |
Response Body
In the response body, the server returns binary data stream.
Example
The example shows how to save OneDrive documents.
Request: POST https://abc.tech.local:4443/v6/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/Organization/OneDrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/Documents/save
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "documents" : [ {"id": "0e4079a2-faa5-41bf-b8a7-ba883308cbc9"}, {"id": "206b13cc-a453-4102-a256-20a64f760e6d"} ] }
Response: 200 OK |