Skip to content

keyring_backup_restore_init

Sectech

Uploads secrets into the device.

It initializes the secret backup restore process, the result can be obtained by the keyring_reconnect call.

Note

This method is not supported when using Remote Access.

Params

attribute description
base64*
string		 Base64 encoded file containing the secrets
strategy*
'replace'|'merge'		 How existing secrets will be treated.
  • replace: All existing user created secrets will be removed prior to import
  • merge: Secrets with identical names will be replaced, new secrets will be added and secrets with non conflicting names will be kept
encryption_passphrase
string		 A passphrase used to optionally decrypt the file

Return

attribute description
delay*
unsigned int		 Indicates in how many seconds the client should attempt to reestablish the connection. The value must be lower than timeout.
interval*
unsigned int		 The interval in seconds between attempts to reconnect after the initial delay
interval_increase*
unsigned int		 By how many seconds should increase the interval between attempts
timeout*
unsigned int		 Indicates after how many seconds should attempts to reestablish connection be given up. It is measured from the moment the response to this call was received by the client. Its value must be greater than delay.
session_id*
string		 The session ID to be used when reconnecting

Example

{
    "delay": 18,
    "interval": 2,
    "interval_increase": 3,
    "timeout": 60,
    "session_id": "GSHGPX"
}