SETTINGS object

Key name

Value type

Title

Required

Possible values

AUTH_CERTS

Object

Information about user, application, web server and Kaspersky Security Center certificates.

Yes

-

certificate_admin

String

Administrator certificate.

Certificate in Base64 format

certificate_admin_name

String

Administrator certificate name

Name of the file containing the certificate

certificate_app_ca

String

Application root certificate

Certificate in Base64 format

certificate_app_ca_name

String

Application root certificate name

Name of the file containing the certificate

certificate_app_cl

String

Application client certificate

Certificate in Base64 format

certificate_app_cl_key

String

Application client certificate key

Key in Base64 format

certificate_app_cl_key_name

String

Application client certificate key name

Name of the file containing the key

certificate_app_cl_name

String

Application client certificate name

Name of the file containing the certificate

certificate_ksc_server

String

Kaspersky Security Center certificate.

Certificate in Base64 format

certificate_ksc_server_name

String

Kaspersky Security Center certificate name.

Name of the file containing the certificate

certificate_web_tls

String

Web server certificate.

Certificate in Base64 format

certificate_web_tls_key

String

Web server certificate key.

Key in Base64 format

certificate_web_tls_key_name

String

Web server certificate key name.

Name of the file containing the key

certificate_web_tls_name

String

Web server certificate name.

Name of the file containing the certificate

DEVICE

Object

Device name.

Yes

-

device_name

String

Device name to display in Kaspersky Security Center

KSC

Object

Object containing information about communications with Kaspersky Security Center

Yes

-

command

String

A command prepared to send to Kaspersky IoT Secure Gateway 1000.

No

reboot

heartbeat

Integer

Period of synchronization with Kaspersky Security Center, in seconds

Integer

MODEM

Object

Information about the modem and settings for telecom carriers.

Yes

-

connection_quality

Integer

Indicator of the current connection quality

No

Received automatically

connection_status

String

Communication status

No

on means the modem is connected and transmitting data; off means the modem is present in the system, but the connection is inactive; na means the modem is not present in the system; unknown means the status is unknown.

is_enable

Literal

Turns the modem on or off.

Yes

true: modem on; false: modem off

primary_dns

String

Primary DNS server

No

String formatted as XXX.XXX.XXX.XXX, for example: "primary_dns": "8.8.8.8"

profileList

Object list

List of mobile network operator profiles

Yes

-

fileContent

String

Profile file content

Yes

Obtained automatically from the profile file

locked

String

Indicates whether the profile is read-only

No

Determined from the predefined and status fields

modified

String

Date and time of the most recent change in the profile.

Yes

Date and time string

name

String

Profile name.

Arbitrary name of the profile.

predefined

Literal

Flag that indicates whether the profile is predefined

true: predefined profile; false: custom profile

status

String

Current status of the profile

active: profile active; inactive: profile inactive

uuid

String

Profile unique ID

No

String representation of boost::uuids::uuid.

secondary_dns

String

Secondary DNS server

No

String formatted as XXX.XXX.XXX.XXX, for example: "secondary_dns": "8.8.4.4"

MQTT_NOTIFICATION

Object

Settings of MQTT notifications.

Yes

-

auth_enabled

Literal

Enables or disables MQTT notifications on behalf of a specific user.

Yes

true means sending on behalf of the user is enabled; false means sending on behalf of the user is disabled.

certificate_cert

String

Client certificate that corresponds to the root certificate

Yes, if "certs_enable": true

Certificate in Base64 format

certificate_key

String

Client key that corresponds to the client certificate

Yes, if "certs_enable": true

Key in Base64 format

certificate_root

String

Root certificate issued by a Certificate Authority.

Yes, if "certs_enable": true

Certificate in Base64 format

certs_enabled

Literal

Enables or disables the use of a secure TLS connection for MQTT notifications.

Yes

true: secure connection enabled; false: secure connection disabled

event_topic

String

Name of the MQTT-topic for sending MQTT notifications.

Yes

MQTT-topic name.

login

String

User name.

Yes, if

User name.

notifications_enabled

Literal

Enables or disables sending events via the MQTT protocol.

Yes

true: sending over the MQTT protocol enabled; false: sending over the MQTT protocol disabled

password

String

User password

Yes, if "auth_enabled": true

Password that corresponds to the user name

server_address

String

MQTT broker IP address

Yes

String formatted as XXX.XXX.XXX.XXX, for example: "server_address": "192.168.1.123"

server_port

Integer

MQTT broker port

Yes

You can use ports 1883 and 8883 to connect Kaspersky IoT Secure Gateway 1000 to an MQTT broker residing in an internal network and port 8883 to connect to an MQTT broker residing in an external network.

SYSLOG

Object

Syslog sending settings.

Yes

-

certificate

String

Content of the security certificate for event forwarding over TCP/TLS

Certificate in Base64 format

enable

Literal

Enables or disables the use of a syslog server for event forwarding.

true: use a syslog server for event forwarding; false: do not use a syslog server for event forwarding.

host

String

IP address and port of the Syslog server

String formatted as XXX.XXX.XXX.XXX, for example: "host": "192.168.1.122"

mode

String

Event forwarding protocol

"tcp": forwarding via TCP; "udp": forwarding via UDP; "???": forwarding over TCP using a TLS connection

port

Integer

Syslog server port

Server port

TIME

Object

The current date and time. Read-only

Yes

-

date

String

Current date

No

Date formatted as "YYYY/MM/DD", for example: "date": "2023/12/31"

time

String

Current time

No

Time formatted as "HH:MM:SS", for example: "time": "23:59:59"

UPDATE

Object

information about updates.

Yes

-

firmware_update_start

Literal

Starting the Kaspersky IoT Secure Gateway 1000 update procedure.

true means an update will run; false is the default value.