KSC Open API
Kaspersky Security Center API description
|
List of events notification settings is presented below.
Name | Type | Description | Global operation |
---|---|---|---|
"KLEVP_ND_SMTP_SERVER" | paramString | SMTP server address to be used for email notifications. | + |
"KLEVP_ND_SMTP_PORT" | paramInt | SMTP server port. | + |
"KLEVP_ND_SMTP_TLS_MODE" | paramInt | SMTP server data encryption mode:
| + |
"KLEVP_ND_SMTP_CA" | paramBinary | List of trusted CA certificates to verify SMTP server, PEM format. Used only when KLEVP_ND_SMTP_TLS_MODE = 2. | + |
"KLEVP_ND_SMTP_TLSVER" | paramInt | Force usage of TLS version:
Used only when KLEVP_ND_SMTP_TLS_MODE = 2. | + |
"KLEVP_ND_SMS_EMAIL_SMTP_TLS_MODE" | paramInt | SMS gateway SMTP server data encryption mode:
| + |
"KLEVP_ND_SMS_EMAIL_SMTP_CA" | paramBinary | List of trusted CA certificates to verify SMS gateway SMTP server, PEM format. Used only when KLEVP_ND_SMS_EMAIL_SMTP_TLS_MODE = 2. | + |
"KLEVP_ND_SMS_EMAIL_SMTP_TLSVER" | paramInt | Force usage of SMS gateway TLS version:
Used only when KLEVP_ND_SMS_EMAIL_SMTP_TLS_MODE = 2. | + |
"KLEVP_ND_EMAIL" | paramString | List of email recipients, separated by a comma. | |
"KLEVP_ND_MESSAGE_TEMPLATE" | paramString | Template of the message to be sent as email. To see the list of available template substitutions, see Events templates. | |
"KLEVP_ND_EMAIL_FROM" | paramString | Sender address. | |
"KLEVP_ND_EMAIL_SUBJECT" | paramString | Email subject. | |
"KLEVP_ND_EMAIL_ESMTP_USER" | paramString | Account name to be used for authorization on the SMTP server. | + |
"KLEVP_ND_EMAIL_ESMTP_PASSWORD" | paramString | Obsolete: Account password to be used for authorization on the SMTP server. | + |
"KLEVP_ND_EMAIL_ESMTP_PASSWORD_EX" | paramBinary | Protected account password to be used for authorization on the SMTP server (see below). | + |
"KLEVP_ND_USE_EMAIL" | paramBool | Using emails for notifications; must be false for default settings. | |
"KLEVP_ND_SMS_TYPE" | paramInt | SMS notification type:
| |
"KLEVP_ND_SMS_SERVICE_ID" | paramString | Unsupported; must be empty. | + |
"KLEVP_ND_SMS_RECIPIENTS" | paramString | SMS recipients list. | |
"KLEVP_ND_SMS_TEMPLATE" | paramString | SMS message template. To see the list of available template substitutions, see Events templates. | |
"KLEVP_ND_SMS_EMAIL_TO" | paramString | Recipient address to be used for the SMTP SMS gateway. | + |
"KLEVP_ND_SMS_EMAIL_FROM" | paramString | Sender address to be used for the SMTP SMS gateway. | + |
"KLEVP_ND_SMS_SMTP_SERVER" | paramString | SMTP SMS gateway server address to be used for SMS notifications. | + |
"KLEVP_ND_SMS_SMTP_PORT" | paramInt | SMTP SMS gateway server port to be used for SMS notifications. | + |
"KLEVP_ND_SMS_EMAIL_SUBJECT" | paramString | Email subject for SMTP messages to be sent to the SMTP SMS gateway. | + |
"KLEVP_ND_SMS_EMAIL_ESMTP_USER" | paramString | Account name to be used for authorization on the SMTP SMS gateway. | + |
"KLEVP_ND_SMS_EMAIL_ESMTP_PASSWORD" | paramString | Obsolete: Account password to be used for authorization on the SMTP SMS gateway. | + |
"KLEVP_ND_SMS_EMAIL_ESMTP_PASSWORD_EX" | paramBinary | Protected account password to be used for authorization on the SMTP SMS gateway (see below). | + |
"KLEVP_ND_USE_SMS" | paramBool | Using SMS for notifications. Must be false for default settings. | + |
"KLEVP_ND_EVETN_TYPE" | paramString | Event type (e.g., "GNRL_EV_VIRUS_FOUND" or "KLPRCI_TaskState"). | |
"KLEVP_ND_NET_SEND" | paramString | Obsolete. Must be empty or not present. | |
"KLEVP_ND_USE_NET_SEND" | paramBool | Obsolete. Must be set to false or not present. | + |
"KLEVP_ND_SCRIPT" | paramString | Script to be run as event notification. | + |
"KLEVP_ND_USE_SCRIPT" | paramBool | Notify on event by running the script. The script itself (KLEVP_ND_SCRIPT) can be set in the same parameters; otherwise, default parameters for the server are used. | + |
"KLEVP_ND_DAYS_TO_STORE_EVENT" | paramInt | Number of days to store events in the Administration Server database. | |
"KLEVP_ND_STORE_AT_SERVER_LOG" | paramBool | Store events in Kaspersky Event Log on Administration Server. | |
"KLEVP_ND_STORE_AT_CLIENT_LOG" | paramBool | Store events in Kaspersky Event Log on the client device. | |
"KLEVP_ND_STORE_AT_CLIENT_PRES" | paramBool | Obsolete parameter - must be set to false or not present. | |
"KLEVP_ND_BODY_FILTER" | paramParams | Event body filter. This rule will be applied to an event, if its body matches the filter. | |
"KLEVP_ND_USE_SNMP" | paramBool | Notify on events by SNMP. | + |
"KLEVP_ND_SMS_LIMIT" | paramInt | Limitation on the number of SMS notifications. | + |
"KLEVP_ND_RESOLVE_MX" | paramBool | Use MX record lookup when email notification is enabled (meaningful only when KLEVP_ND_USE_EMAIL is set to true). When enabled, KLEVP_ND_SMTP_SERVER is interpreted as a domain name which is to be resolved. | + |
"KLEVP_ND_USE_SYSLOG" | paramBool | Notify on events by exporting to SysLog. | + |
As an alternative to user credentials (i.e. "KLEVP_ND_EMAIL_ESMTP_USER" and "KLEVP_ND_EMAIL_ESMTP_PASSWORD"), client certificate authentication can be used. When the certificate type is set to 5 (see "KLCERTP::CertificateFunction enum values"), the custom certificate will have higher priority than user's login and password. See Common format for certificate parameters.
Since KSC 12 if some parameters are not set in the settings, such parameters are not changed in the server database. In older KSC, these parameters are saved to the server database with a default value in this case.
Since KSC 12, the global operations rights may be required for some parameters. See Global operation column in table.
Protect password as an encrypted UTF16 string with the server (global) key.
Typical filtering attribute for KLEVP_ND_BODY_FILTER is KLPRCI_newState, which can have one of the following values: