Skip to content

keyring_secret_add

Sectech

Creates an empty secret.

Params

attribute description
id*
string; ^[a-zA-Z][a-zA-Z0-9_]{0,127}$
Unique human readable ID of the secret
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

Return

attribute description
secrets*
[Secret status]
An array with the status of the secrets present in the device

Secret status

attribute description
id*
string
Unique human readable key of the secret
type*
'pkey_cert'|'cert_single'|'cert_chain'|'dhparam'|'remote_access'|'ssh_private'|'uftp'|'psk'|'openvpn'
The secret type
is_empty
bool
Indicates if the secret is empty. If not spcified false is assumed.
note
string
User description of the secret
expiry_tstamp
unsigned integer
The secret expiry time if applicable
is_read_only
bool
Indicates manufacturer provided certificate that the user can not remove or alter. Default value is false