KSC Open API
Kaspersky Security Center API description
|
List of extra report parameters is presented below.
Name | Type | Description |
---|---|---|
"KLRPT_QUERY_ID" | paramInt | Hosts query identity. For reports based on a hosts query, group identity for the report should be -1. |
"KLRPT_DONT_USE_SPACES_FOR_SLASHES" | paramBool | Do not include extra soft-break symbols after slashes (used to force words breaking in printable form). The default value is false. |
"KLRPT_TEMPORAL" | paramBool | A sign for temporal report templates (which should be deleted right after the report generation). The default value is false. |
"KLRPT_EXPAND_PERIOD" | paramBool | Should extend the report period to 23:59:59 with the time zone of the user generating the report. The default value is true. |
"KLRPT_GLOBAL_SCOPE" | paramBool | Specifies if the report is for the entire system (including unmanaged hosts), not just for a managed group or hosts list. The default value is false. |
"KLRPT_FLD_FILTER" | paramParams |
|
"KLRPT_FLD_FILTER_EX" | paramParams |
KLRPT_FLD_FILTER_EX - PARAMS +--[Filter display name 1] - PARAMS | +--KLRPT_FLD_FILTER - PARAMS. See List of report filter attributes. | +--KLRPT_FLT_CONDITION | +--KLRPT_FLT_VALUE | +--KLRPT_FLT_VALUE2 ... +--[Filter display name N]For details on possible filter values for certain report fields, see List of report field types. |
"KLRPT_SLAVE_REC_DEPTH" | paramInt | Hierarchy level of the secondary servers to collect the report data from. Use -1 - for all secondary servers with no level limit. Use 0 (default) - for current server only (do not receive report data from secondary servers). |
"KLRPT_INCLUDE_SLV_DTL_RECORDS" | paramBool | Collect detailed report data from the secondary reports. |
"KLRPT_CACHE_PERIOD_MINUTES" | paramInt | Period (in minutes) to cache the report data received previously from the secondary servers. Possible values:
|
"KLRPT_SLAVE_EXEC_TIMEOUT" | paramInt | Period (in seconds) to wait for the report execution results from the secondary servers. The default value is 300. |
"KLRPT_DEPLOYMENT_ALL_HOSTS" | paramBool | Special parameter for the "Deployment" report (report type 18). Should be true if the report is for the entire system including unmanaged hosts. The default value is false. |
List of protection status report (report type ID is 0). Extra parameters are presented below.
Name | Type | Description |
---|---|---|
"KLRPT_PROTECTION_INCLUDE_WARNING" | paramBool | Include hosts with status "Warning". The default value is false. |
"KLRPT_PROTECTION_INCLUDE_OK" | paramBool | Include hosts with status "OK". The default value is true. |
"KLRPT_PROTECTION_INCLUDE_VM" | paramBool | Include virtual machines. The default value is true. |
List of event report (report type ID is 17). Extra parameters are presented below.
Name | Type | Description |
---|---|---|
"KLRPT_SEVER_MASK" | paramInt | Event severity mask. See Event severity masks for event report. |
List of report on Device Control events (report type ID is 24). Extra parameters are presented below.
Name | Type | Description |
---|---|---|
"KLRPT_EVENTS_MASK" | paramInt | Device Control event mask. See Event mask used in the report on Device Control events. |
List of hardware report (report type ID is 34). Extra parameters are presented below.
Name | Type | Description |
---|---|---|
"KLRPT_EVENTS_MASK" | paramInt | Hardware inventory object type mask, may include bits from Object type mask used in hardware report. |
List of report on rights (report type ID is 39) extra parameters is presented below.
Name | Type | Description |
---|---|---|
"KLRPT_USERS_RIGHTS_INCLUDE_ROLES" | paramBool | Include role permissions. The default value is false. |
"KLRPT_USERS_RIGHTS_INCLUDE_VS" | paramBool | Include virtual servers. The default value is false. |
List of report on effective user permissions (report type ID is 40). Extra parameters are presented below.
Name | Type | Description |
---|---|---|
"KLRPT_TRUSTEE_ID" | paramInt | User trustee ID. |