Page History

REST API Method: POST /rest/system?action=restore

This action restores the SBC's backup configuration file.

Info
If the action fails, a set of Application Status Error Codes will be returned representing all configuration validation errors found in the file and detected by the SBC. If the action succeeds, the SBC will automatically reboot.

https://192.168.0.111/rest/system?action=restore

POST

true

Noprint

Panel

bgColor	transparent
titleBGColor	#DDD
title	[system - REST API Methods\|Resource - system]

Page Tree

root	@parent

Parameter Name	Required	Service Affecting	Data Type	Default Value	Possible Values	Description
Filename	Yes	Yes	string	none	255 - Max Length	Identifies the name of the backup configuration file being restored into the SBC. File needs to be of extension .tar or .tar.gz
Passphrase	No	Yes	string	none	128 - Max Length	Identifies the passphrase to be used for the password decryption operation. If the password decryption fails, all the passwords in the configuraion will be set to NULL, and the user should reset all the passwords manually. The password decryption fails in two circumstances 1) when the wrong passphrase used for the restore operation. 2) When the configuration was backed up with the passphrase and the same configuration is restored into a node without the passphrase.
ReplacePasswords	No	Yes	Enum	1	Possible values: 0 - btFalse 1 - btTrue	Specifies whether username and passwords from the backup being restored should replace the current ones.