Restore a backup. If the request is well formed and if the backup can be restored, a success response will be returned and the controller will restart.
URL
/ctrl/backup
Method
POST
URL Params
action=restore Required
See Common URL parameters
Data Params
- backup= {path where the backup is stored} Required. Path must be part of the controller file system. Environment variables such as $TEMP, $SYSTEM shall be possible to have in the path. Example: backup=/fileservice/$syspar/tempfolder
- ignore = {all | system-id | template-id | none} Mismatches between backup and current system that should be ignored at restore. Defaults to none
- delete-dir = {true | false} Indicate whether the backup directory should be deleted after the restore is finished. Defaults to true
- include-cs={true |false } Indicate if controller settings are to be included in the restore. Defaults to true
- include-ss={true |false } Indicate if safety settings are to be included in the restore. Defaults to true
- include ={ cfg| modules | all } Indicate if what is to be included in the restore. Defaults to all
Success Response
see HTTP Status codes
Example Response
No content
Error Response
UNSUPPORTED_MEDIA(415), FORBIDDEN(403), BAD_REQUEST(400)
See Robot controller return codes
Sample Call
`curl –digest -u "Default User":robotics -d "backup=/fileservice/$syspar/tempfolder" -X POST "http://localhost/ctrl/backup?action=restore"
Notes
- Requires UAS grant Restore a backup
- Not supported in bootserver mode