Skip to content

keyring_secret_upload_init

Sectech

Uploads a new secret into the device.

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

Params

Either id or type must be defined, but not both.

attribute description
base64*
string		 Base64 encoded file containing the secret. The supported types are:
  • pkey_cert: PEM, DER, PKCS12, PKCS8
  • cert_single: PEM, DER, PKCS12, PKCS8
  • cert_chain: PEM, DER, PKCS12, PKCS8
  • dhparam: PEM, DER
  • remote_access: PEM (*.rmtkey)
  • ssh_private: binary (*.dbkey), PEM (*.pem)
  • uftp: PEM (*.uftp)
  • psk: hexadecimal (*.pskey)
  • openvpn: text (*.ovpn_key)
  • encrypted data: ZIP (*.zip)
encryption_passphrase
string		 A passphrase used to decrypt the uploaded file if applicable
id*
string; ^[a-zA-Z][a-zA-Z0-9_]{0,127}$		 The ID of the secret to populate with the uploaded data. If the ID already exists in the device, the secret will be updated. If the ID does not exist a new secret will be created.
type*
'pkey_cert'|'cert_single'|'cert_chain'|'dhparam'|'remote_access'|'ssh_private'|'uftp'|'psk'|'openvpn'		 The secret type
note
^[^"`\\$;]{0,42}$		 User description of the secret. It can only be specified when creating a new secret, that is when id does not belong to an existing secret.

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"
}