KSC Open API
Kaspersky Security Center API description
|
The report contains the following structure, which can be presented in the XML or JSON format:
+---data +---records | +---record | | +---field(value, df_val, hst) | | +---field(value, df_val, hst) | | ... | | +---field(value, df_val, hst) | +---record | | +---field(value, df_val, hst) | | +---field(value, df_val, hst) | | ... | | +---field(value, df_val, hst) | ... | +---record | | +---field(value, df_val, hst) | | +---field(value, df_val, hst) | | ... | | +---field(value, df_val, hst) | +---reccount | +---totreccount | +---records_header | +---records_header_capt | +---records_header_num +---sumrecords | +---record | | +---field(value, df_val, hst) | | +---field(value, df_val, hst) | | ... | | +---field(value, df_val, hst) | +---record | | +---field(value, df_val, hst) | | +---field(value, df_val, hst) | | ... | | +---field(value, df_val, hst) | ... | +---record | | +---field(value, df_val, hst) | | +---field(value, df_val, hst) | | ... | | +---field(value, df_val, hst) | +---reccount | +---totreccount | +---records_header +---summary | +---heading | +---subhead | +---description | +---generation_date | +---totals | +---record | | +---field(name, value, hst) | | +---field(name, value, hst) | | ... | | +---field(name, value, hst) | +---reccount | +---totreccount +---fields | +---field(name, order, df_name) | +---field(name, order, df_name) | ... | +---field(name, order, df_name) +---sumfields | +---field(name, order, df_name) | +---field(name, order, df_name) | ... | +---field(name, order, df_name) +---main_srv | +---header | +---summary | | +---record | | | +---field(value, df_val, order, hst) | | | +---field(value, df_val, order, hst) | | | ... | | | +---field(value, df_val, order, hst) | | +---record | | | +---field(value, df_val, order, hst) | | | +---field(value, df_val, order, hst) | | | ... | | | +---field(value, df_val, order, hst) | | ... | | +---record | | | +---field(value, df_val, order, hst) | | | +---field(value, df_val, order, hst) | | | ... | | | +---field(value, df_val, order, hst) | | +---reccount | | +---totreccount | | +---records_header | +---totals | +---record | | +---field(name, value, hst) | | +---field(name, value, hst) | | ... | | +---field(name, value, hst) | +---reccount | +---totreccount +---slavedata +---srv | +---name | +---inst | +---level | +---cache_time | +---totals | | +---record | | +---field(name, value, hst) | | +---field(name, value, hst) | | ... | | +---field(name, value, hst) | +---summary | | +---record | | | +---field(name, value, df_val, order, hst) | | | +---field(name, value, df_val, order, hst) | | | ... | | | +---field(name, value, df_val, order, hst) | | +---record | | | +---field(name, value, df_val, order, hst) | | | +---field(name, value, df_val, order, hst) | | | ... | | | +---field(name, value, df_val, order, hst) | | ... | | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---records | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | ... | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---records_header | +---records_header_capt | +---records_header_num +---srv | +---name | +---inst | +---level | +---cache_time | +---totals | | +---record | | +---field(name, value, hst) | | +---field(name, value, hst) | | ... | | +---field(name, value, hst) | +---summary | | +---record | | | +---field(name, value, df_val, order, hst) | | | +---field(name, value, df_val, order, hst) | | | ... | | | +---field(name, value, df_val, order, hst) | | +---record | | | +---field(name, value, df_val, order, hst) | | | +---field(name, value, df_val, order, hst) | | | ... | | | +---field(name, value, df_val, order, hst) | | ... | | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---records | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | ... | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---records_header | +---records_header_capt | +---records_header_num ... +---srv | +---name | +---inst | +---level | +---cache_time | +---totals | | +---record | | +---field(name, value, hst) | | +---field(name, value, hst) | | ... | | +---field(name, value, hst) | +---summary | | +---record | | | +---field(name, value, df_val, order, hst) | | | +---field(name, value, df_val, order, hst) | | | ... | | | +---field(name, value, df_val, order, hst) | | +---record | | | +---field(name, value, df_val, order, hst) | | | +---field(name, value, df_val, order, hst) | | | ... | | | +---field(name, value, df_val, order, hst) | | ... | | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---records | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | ... | +---record | | +---field(name, value, df_val, order, hst) | | +---field(name, value, df_val, order, hst) | | ... | | +---field(name, value, df_val, order, hst) | +---records_header | +---records_header_capt | +---records_header_num +---totals +---totals_na +---totals_na_present +---totals_cached +---totals_cached_present
The element description is presented in the table below.
Element | Cardinality | Description | Attributes |
---|---|---|---|
data | Required, single. | Root element. | - |
data/records | Required, single. | Report data presented in the table form. The element contains descriptions of three different types:
| - |
data/records/record | Optional, multiple. | Row from the table with the report data. | - |
data/records/record/field | Optional, multiple. | Cell from the table with the report data. |
|
data/records/reccount | Required, single. | Number of received records in the table with the report data. | - |
data/records/totreccount | Required, single. | Total number of records in the table with the report data. Can be less than the "totreccount" value if the report settings limit the number of requested records. | - |
data/records/records_header | Required, single. | Header of the table with the report data, for example, "Details (shown 2000 of 12345)". | - |
data/records/records_header_capt | Required, single. | Short header of the table with the report data, for example, "Details". | - |
data/records/records_header_num | Required, single. | Short header postfix of the table with the report data, for example, "2000 of 12345". | - |
data/sumrecords | Required, single. | Table with aggregated report data. | - |
data/sumrecords/record | Optional, multiple. | Table row with aggregated report data. | - |
data/sumrecords/record/field | Optional, multiple. | Table cell with aggregated report data. |
|
data/sumrecords/reccount | Required, single. | Number of received records in the table with aggregated report data. | - |
data/sumrecords/totreccount | Required, single. | Total number of records in the table with aggregated report data. Can be less than the "totreccount" value if the report settings limit the number of requested records. | - |
data/sumrecords/records_header | Required, single. | Header of the table with aggregated report data, for example, "Summary". | - |
data/summary | Required, single. | Summary information about the report. | - |
data/summary/heading | Required, single. | Report heading, for example, "Report on Kaspersky Lab software versions". | - |
data/summary/subhead | Required, single. | Report subhead, for example, "Report on Kaspersky Lab software versions". | - |
data/summary/description | Required, single. | Report description, for example, "Report on Kaspersky Lab software versions installed on managed devices in all administration groups". | - |
data/summary/generation_date | Required, single. | Report generation date and time, for example, "Wednesday, March 29, 2017 2:44:28 AM". | - |
data/summary/totals | Required, single. | Report holder by the total statistics (high-level aggregated counters). | - |
data/summary/totals/record | Required, single. | Data from report with the total statistics (high-level aggregated counters). | - |
data/summary/totals/record/field | Required, multiple. | Entry in the report with the total statistics (high-level aggregated counter). |
|
data/summary/totals/reccount | Required, single. | Must be "1". | - |
data/summary/totals/totreccount | Required, single. | Must be "1". | - |
data/summary/fields | Required, single. | Description of table columns with data from the report. | - |
data/summary/fields/field | Required, multiple. | Description of the specific table column with data from the report. |
|
data/summary/sumfields | Required, single. | Description of the table columns with the aggregated data from the report. | - |
data/summary/sumfields/field | Required, multiple. | Description of the specific table column with the aggregated data from the report. |
|
data/main_srv | Optional, single. | Aggregated report data only from the primary server. The case is considered when the report includes data from the secondary servers in the hierarchy of servers. | - |
data/main_srv/header | Required, single. | Section header of the primary server data, for example, "Master Administration Server report". | - |
data/main_srv/totals | Required, single. | Holder of the total statistics of the primary server (high-level aggregated counters). | - |
data/main_srv/totals/record | Required, single. | Data of the total statistics of the primary server (high-level aggregated counters). | - |
data/main_srv/totals/record/field | Required, multiple. | Entry of the total statistics of the primary server (high-level aggregated counter). |
|
data/main_srv/totals/reccount | Required, single. | Must be "1". | - |
data/main_srv/totals/totreccount | Required, single. | Must be "1". | - |
data/main_srv/summary | Required, single. | Table with the aggregated report data of the primary server. | - |
data/main_srv/summary/heading | Required, single. | Heading of the section with aggregated data of the primary server, for example, "Summary". | - |
data/main_srv/summary/record | Optional, multiple. | Row of the table with aggregated report data of the primary server. | - |
data/main_srv/summary/record/field | Optional, multiple. | Cell of the table with aggregated report data of the primary server. |
|
data/main_srv/summary/reccount | Required, single. | Number of received records in the table with the aggregated report data of the primary server. | - |
data/main_srv/summary/totreccount | Required, single. | Total number of records in the table with the aggregated report data of the primary server. | - |
data/slavedata | Optional, single. | Section containing data from secondary servers grouped by the servers. The case is considered when the report includes data from the secondary servers in the hierarchy of servers. | - |
data/slavedata/srv | Optional, multiple. | Report data from the certain secondary server. The case is considered when the report includes data from the secondary servers in the hierarchy of servers. | - |
data/slavedata/srv/name | Required, single. | Displayed name of the secondary server. | - |
data/slavedata/srv/inst | Required, single. | Secondary server instance ID. | - |
data/slavedata/srv/level | Required, single. | Secondary server hierarchy level. | - |
data/slavedata/srv/cache_time | Optional, single. | Secondary server data cache time. The case is considered when data for this server is got from cache. | - |
data/slavedata/srv/totals | Required, single. | Holder of the total statistics of the secondary server (high-level aggregated counters). | - |
data/slavedata/srv/totals/record | Required, single. | Data of the total statistics of the secondary server (high-level aggregated counters). | - |
data/slavedata/srv/totals/record/field | Required, multiple. | Entry of the total statistics of the secondary server (high-level aggregated counter). |
|
data/slavedata/srv/summary | Required, single. | Table with the aggregated report data of the secondary server. | - |
data/slavedata/srv/summary/record | Optional, multiple. | Table row with the aggregated report data of the secondary server. | - |
data/slavedata/srv/summary/record/field | Optional, multiple. | Table cell with the aggregated report data of the secondary server. |
|
data/slavedata/srv/records | Optional, single. | Table with data of the secondary server. | - |
data/slavedata/srv/records/record | Optional, multiple. | Table row with data of the secondary server. | - |
data/slavedata/srv/records/record/field | Optional, multiple. | Table cell with data of the secondary server. |
|
data/slavedata/srv/records/records_header | Required, single. | Header of the table with the report data of the secondary server, for example, "Details (shown 2000 of 12345)". | - |
data/slavedata/srv/records/records_header_capt | Required, single. | Header of the table with the report data of the secondary server, for example, "Details". | - |
data/slavedata/srv/records/records_header_num | Required, single. | Short header postfix of the table with the report data of the secondary server, for example, "2000 of 12345". | - |
data/slavedata/totals | Required, single. | Description of the section containing data from secondary servers, for example, "Number of the secondary Administration Servers: 2". | - |
data/slavedata/totals_na | Required, single. | Number of servers for which data in the report is missing, for example, "N/A servers: 0". | - |
data/slavedata/totals_na_present | Required, single. | Should be "1" if there are some servers for which data in the report is absent. | - |
data/slavedata/totals_cached | Required, single. | Information about the number of servers for which data is got from cache, for example, "Cached servers: 0". | - |
data/slavedata/totals_cached_present | Required, single. | Should be "1" if there are some servers for which data is got from cache. | - |