POST api/2.0/portal/startrestore This function requires authentication

Description

Starts the data restoring process for the current portal with the parameters specified in the request.

Parameters
Name Description Type Example
backupId
sent in body
Backup ID string some text
storageType
sent in body
Storage type ("Documents", "ThridpartyDocuments", "CustomCloud", "Local", "DataStore", or "ThirdPartyConsumer") Documents, ThridpartyDocuments, CustomCloud, Local, DataStore, ThirdPartyConsumer Documents
storageParams
sent in body
Storage parameters Dictionary(key:string, value:string)
collection
[{"Key": "some text","Value": "some text"}]
notify
sent in body
Specifies whether to notify the users about the backup or not Bool value true
Example
POST api/2.0/portal/startrestore
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "backupId": "some text",
  "storageType": "Documents",
  "storageParams": [
    {
      "Key": "some text",
      "Value": "some text"
    }
  ],
  "notify": true
}
Returns

Restoring progress

Example Response

application/json

{
  "status": 0,
  "response": {
    "IsCompleted": false,
    "Progress": 44,
    "Error": null,
    "Link": "Link"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <IsCompleted>False</IsCompleted>
    <Progress>44</Progress>
    <Error />
    <Link>Link</Link>
  </response>
</result>