Restore

URL:
https://<root>/system/disasterrecovery/stores/<storeName>/backups/<backupName>/restore
Methods:
POST
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
10.9

Description

The restore operation restores the organization to the state it was in when a specific backup was created. When restoring an organization to a previous state, any existing content and data present in its current state is replaced with the data contained in the backup.

Request parameters

ParameterDetails

storeName

The name of the store the backup was copied to.

passcode

The pass code used to encrypt the backup. This pass code must be the same as the one used when creating the backup.

Example
Use dark colors for code blocksCopy
1
passcode=backuppass

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the restore operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/system/disasterrecovery/stores/sampleStore1/backups/sampleBackup1/restore HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

passcode=backuppass&f=pjson&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1e

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.