KSC Open API
Kaspersky Security Center API description
|
Below is the partial structure of parameters container of report delivery task.
+--- (params) ... +---KLRPT_LOC_PRODUCTS (array) | +---0 (params) | +---KLRPT_PROD_NAME (paramString) = "1093" | +---KLRPT_PROD_NAME_LOC (paramString) = "Administration Server" | +---KLRPT_PROD_VER (paramString) = "1.0.0.0" | +---KLRPT_PROD_VER_LOC (paramString) = "1.0.0.0" +---KLSRV_TP_EMAIL_REPORT_SEND_MAIL (paramBool) = true +---KLSRV_TP_EMAIL_REPORT_EMAIL (paramString) = "Sergey.Kostrov@kaspersky.com" +---KLSRV_TP_EMAIL_REPORT_SUBJECT (paramString) = "KSC Report delivery" +---KLSRV_TP_EMAIL_REPORT_ATTACHMENT_TYPE (paramInt) = 2 +---KLSRV_TP_EMAIL_REPORT_FORMAT (paramInt) = 1 +---KLSRV_TP_EMAIL_REPORT_ID (paramInt) = 19 +---KLSRV_TP_EMAIL_REPORT_IDS (array) | +---0 (paramInt) = 19 +---KLSRV_TP_EMAIL_REPORT_SAVE (paramBool) = true +---KLSRV_TP_EMAIL_REPORT_FOLDER (paramString) = "C:\Users\kostrov\Downloads\" +---KLSRV_TP_EMAIL_REPORT_OVERWRITE (paramBool) = true +---KLSRV_TP_EMAIL_REPORT_USE_ACCOUNT (paramBool) = false +---KLSRV_TP_EMAIL_REPORT_USE_SERVER_SETTINGS (paramBool) = true ...
Below is the list of attributes specific to report delivery task.
Attribute | Type | Description | Additional information |
---|---|---|---|
"KLRPT_LOC_PRODUCTS" | (array) | Array of product internal and localized names and versions |
|
"KLRPT_PROD_NAME" | (paramString) | Name of product |
|
"KLRPT_PROD_NAME_LOC" | (paramString) | Localized name of product |
|
"KLRPT_PROD_VER" | (paramString) | Version of product |
|
"KLRPT_PROD_VER_LOC" | (paramString) | Localized version of product |
|
"KLSRV_TP_EMAIL_REPORT_SEND_MAIL" | (paramBool) | The parameter accepts true if a report should be sent by email, false - otherwise |
|
"KLSRV_TP_EMAIL_REPORT_ATTACHMENT_TYPE" | (paramInt) | Email attachment type |
|
"KLSRV_TP_EMAIL_REPORT_EMAIL" | (paramString) | Email address which a report files should be sent to |
|
"KLSRV_TP_EMAIL_REPORT_SUBJECT" | (paramString) | Subject of the report email |
|
"KLSRV_TP_EMAIL_REPORT_FORMAT" | (paramInt) | Report target format, see Types of the report XML target format |
|
"KLRPT_PDF_LANDSCAPE" | (paramBool) | The parameter accepts true if PDF report document should be landscape oriented, false - otherwise |
|
"KLRPT_PDF_PAGE_SIZE" | (paramInt) | Page size for PDF report document, see Sizes of a PDF report document |
|
"KLSRV_TP_EMAIL_REPORT_ID" | (paramInt) | Report ID |
|
"KLSRV_TP_EMAIL_REPORT_IDS" | (array) | Array of report IDs |
|
"KLSRV_TP_EMAIL_REPORT_SAVE" | (paramBool) | The parameter accepts true if a report should be saved to a specified folder of the file system, false - otherwise |
|
"KLSRV_TP_EMAIL_REPORT_FOLDER" | (paramString) | Folder of the file system which the report file must be saved to |
|
"KLSRV_TP_EMAIL_REPORT_OVERWRITE" | (paramBool) | The parameter accepts true if previously generated files of the same report type must be replaced with the new ones, false - otherwise |
|
"KLSRV_TP_EMAIL_REPORT_USE_ACCOUNT" | (paramBool) | Use credentials to access the folder which a report was saved to |
|
"KLSRV_TP_EMAIL_REPORT_ACCOUNT" | (paramString) | User name |
|
"KLSRV_TP_EMAIL_REPORT_PWD" | (paramBinary) | Password |
|
"KLSRV_TP_EMAIL_REPORT_USE_SERVER_SETTINGS" | (paramBool) | The parameter accepts true if default notification setting should be used, false - otherwise |
|
"KLSRV_TP_EMAIL_REPORT_SMTPSERVER" | (paramString) | SMTP server address |
|
"KLSRV_TP_EMAIL_REPORT_SMTPPORT" | (paramInt) | SMTP port |
|
"KLSRV_TP_EMAIL_REPORT_ESMTPUSER" | (paramString) | SMTP user name |
|
"KLSRV_TP_EMAIL_REPORT_ESMTPPASSWORD" | (paramString) | SMTP password |
|
Description of general attributes applicable to any server task could be found by the references below: