|
KSC Open API
Kaspersky Security Center API description
|
Views for quarantine, backup, and unprocessed network lists have the same format.
View name for Quarantine network list: "Quarantine"
View name for Backup network list: "Backup"
View name for unprocessed files network list: "TIF"
List of view attributes is presented below.
| Name | Type | Description | Remarks |
|---|---|---|---|
| "nId" | paramInt | Item ID from the database. | Unique for one Administration Server. |
| "strListProductName" | paramString | Internal name of the product that has a network list. | Supported from KSC 13. |
| "strListProductVersion" | paramString | Internal version of the product that has a network list. | Supported from KSC 13. |
| "strListProductDisplayName" | paramString | Display name of the product that has a network list. | Supported from KSC 14.1 |
| "strListProductDisplayVersion" | paramString | Display version of the product that has a network list. | Supported from KSC 14.1. |
| "strId" | paramString | Item string ID on the host. | |
| "strHostDisplayName" | paramString | Host display name. | |
| "nGroup" | paramInt | ID of administration group where the host is located. | Host may be moved by changing the value of this attribute. |
| "strHostName" | paramString | Host name. A unique server-generated string. | |
| "KLVSRV_ID" | paramInt | Virtual server ID. | Read-only. |
| "KLVSRV_DN" | paramString | Virtual server display name. |
|
| "taskName" | paramString | Name of the action that is executed over the item. | Empty if no action is executed. |
| "taskError" | paramString | Description of the error of the action that is executed over the item. | Empty if no action is executed or if no error occurs. |
| "ObjName" | paramString | Name of the object in the list. | |
| "szRestorePath" | paramString | Restore path for the object. | May be empty if the object is not restored. |
| "szDescription" | paramString | Information field. For example, name of the file container. | |
| "szFileTitle" | paramString | Name of the file without path. | |
| "szUser" | paramString | Name of the user who put the object to the list. | Attribute should be non-empty if "iObjStatus" is equal to 4. |
| "VirusName" | paramString | Name of the suspected virus. |
|
| "iObjStatus" | paramInt | Item status. Uses one of the following constants:
|
|
| "QBStoreTime" | paramDateTime | Time when the item has been put to the list, in UTC. | May be absent. |
| "QBObjSize" | paramInt | File (object) size in bytes. | May be absent. |
| "SentToKLDate" | paramDateTime | Time when object has been sent to Kaspersky. | May be absent. |
| "QBLastCheckBaseDate" | paramDateTime | Time when object has been checked last time. | May be absent. |