VIVOTEK
User's Manual - 427
© 2020 VIVOTEK INC. All Right Reserved
296
http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[¶meter=<value
>]
PARAMETER
VALUE
DESCRIPTION
operation
automode, manualmode
"automode":
Key pair will be generated, and
automatically copy public key to server.
"manualmode":
Key should be downloaded or
uploaded by user.
* This field is required.
key
download, upload
"download":
Download public key.
"upload":
Upload private key. Only support HTTP
POST and “content-type: multipart/form-data”.
HTTP headers with its name=”parameter” or
name=” uploadKeyFile” will be describing the
request body, see examples below.
* Required when operation=manualmode
address
<sftp server address or
hostname>
sftp server address or hostname
* This field is required.
port
<sftp port>
sftp port
index
0~4
Event setting server index
* This field is required.
username
string[64]
Sftp server username
* This field is required.
passwd
string[64]
Sftp server password
* Required when operation=automode.
fingerprint_enable <Boolean>
Verify fingerprint
* Default is 1.
fingerprint_content <128-bit hash value>
Fingerprint content
* Required when fingerprint_enable=1.
passphrase_enable <Boolean>
Enable passphrase
© 2020 VIVOTEK INC. All Right Reserved
297
* Only valid when operation=manualmode and
key=upload.
passphrase_content <128-bit hash value >
Passphrase
* Only valid when operation=manualmode and
key=upload.
location
string[128]
sftp server file location
name
string[40]
Username for server_i<index>_name
* The default value is sftp<index>.
keytype
ed25519, rsa, ecdsa
"ed25519":
faster to generate with higher
security level, some old server might not support.
"rsa":
slower to generate with slightly lower
security level than ed25519.
"ecdsa":
low security level.
A keytype will be automatically selected if the
parameter is not provided. The selected order
will be ed25519/rsa/ecdsa until successful
pairing, an error message will return if all keytype
failed.
* Required when operation=download.
Example of download key:
Request:
http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=manualmode&key=download&index=
1&address=<ip>&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5
value>&keytype=ecdsa
Response of success:
HTTP/1.1 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: <Success Message Length>\r\n
\r\n
ok
Request:
http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=manualmode&key=download&index=
1&address=<ip>&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5