KSC Open API

https://support.kaspersky.com/help/KSC/13.2/KSCAPI/
Admin
KSC Open API is an HTTP interface for managing the Kaspersky Security Center (KSC) server, enabling...
Tokens:1,846,771
Snippets:12,226
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### KLVSRV_PRODUCTS Structure Example

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00021

Provides an example of the data structure for KLVSRV_PRODUCTS, which describes products installed on hosts. It details attributes like product display name, version, and installation count.

```plaintext
+--- <name of product>(paramParams)
     +--- <version of product>(paramParams)
          +--- KLVSRV_PROD_DN = (paramString)<"display name one of the builds">
          +--- KLVSRV_PROD_DV =(paramString)<"display version one of the builds">
          +--- KLVSRV_PROD_CNT =(paramInt)<count of installations>
```

--------------------------------

### KLVSRV_PRODUCTS_2 Structure Example

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00021

Illustrates the data structure for KLVSRV_PRODUCTS_2, which also describes installed products but includes a KLVSRV_PROD_BUILDS array. Each entry in the array contains product display name, version, and installation count.

```plaintext
+--- <name of product>(paramParams)
     +--- <version of product>(paramParams)
          +--- KLVSRV_PROD_BUILDS(paramArray)
               +---0 (paramParams)
                   +--- KLVSRV_PROD_DN = (paramString)<"display name of Ã  build">
                   +--- KLVSRV_PROD_DV =(paramString)<"display version of a build">
                   +--- KLVSRV_PROD_CNT =(paramInt)<count of installations>
```

--------------------------------

### Install License for Product on Host (KSC API)

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00527_a4f030d9057b9b25332124aac49943c06

Installs a license for a product on a host using the KSC Open API. It takes license information and a flag indicating whether to install it as active or reserved. The method handles potential errors during installation.

```KSC API
LicenseInfoSync::TryToInstallLicForSaas2(params pKeyInfo, boolean bAsCurrent)
```

--------------------------------

### File Download Request Example (HTTP GET)

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/index

Shows an example of an HTTP GET request for downloading a file, including the 'Accept-Encoding' and 'Range' headers. This request is made after authentication.

```HTTP
GET /PRFX/Some/test/file HTTP/1.1
Accept-Encoding: identity
Range: bytes=0-99
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00454

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00323

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00033

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Get Updates Count by Installation State

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00064

Provides a count of updates based on their installation state for a specified period. It helps in understanding the distribution of update installation statuses.

```API
DSHT_DATA entries:
  "nType" (paramInt) - Update installation status.
  "nCount" (paramInt) - Number of updates having given installation status on some computers.
```

--------------------------------

### Get Patch Install Command

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00549

Retrieves the install command for a patch using either patch ID and location ID, or by package ID.

```C#
PatchParameters.GetValues(long patchID, int locID)
PatchParameters.GetValuesByPkg(int packageId)
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00326

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Get Updates Count by Installation State and Classification

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00064

Returns the count of updates categorized by their installation state and classification. This allows for a more granular analysis of update deployment.

```API
DSHT_DATA entries:
  "nType" (paramInt) - Update installation status.
  "nType2" (paramInt) - Update classification.
  "nCount" (paramInt) - Number of updates that have the specified status.
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00289

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00299

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Get Installed/Failed Updates Count by Result and Classification

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00064

Details the count of installed or failed updates, broken down by installation result and classification. This is useful for diagnosing update issues.

```API
DSHT_DATA entries:
  "nType" (paramInt) - Update installation status.
  "nType2" (paramInt) - Update classification (KLWUS::CategoryType).
  "nCount" (paramInt) - Number of updates that have the specified status.
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00249

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Get Host System Start and Reboot Information

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00011

Provides the last system start time, indicates if a reboot is required, and details the reasons and time for any reboot requests.

```KSC API Parameters
"KLHST_WKS_LAST_SYSTEM_START" | paramDateTime | Last system start time. Read-only. |
"KLHST_WKS_RBT_REQUIRED" | paramBool | If reboot is required. Read-only. |
"KLHST_WKS_RBT_REQUEST_REASON" | paramInt | Reboot request reasons mask, bit set: bit 0 - unspecified, bit 1 - unusable until reboot, bit 2 - usable but reboot needed for update, bit 3 - reboot needed to initiate update, bit 4 - reboot needed to complete scanning/curing, bit 5 - reboot needed to complete installation/uninstallation. Read-only. |
"KLHST_WKS_RBT_REQUEST_TIME" | paramDateTime | Reboot request time. Read-only.
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00213

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00056

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Get Host Installed Application Information

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00011

Retrieves detailed information about installed products on a host, including their versions, states, and state change times. This parameter is only usable in the GetHostInfo method.

```KSC API Parameters
"KLHST_APP_INFO" | paramParams | Information about products installed on the host. Format: 
    "KLHST_APP_INFO" |
    +--_<product>_ (paramParams) |
        |
        +--_<version>_ (paramParams) |
            |
            +--"KLHST_APP_STATE" (paramInt) |
            |
            +--"KLHST_APP_STATE_TIME" (paramDateTime) 
Where _<product>_ is product name and _<version>_ is version. "KLHST_APP_STATE" is product state (0=Inactive, non-zero=Active). "KLHST_APP_STATE_TIME" is last time state changed. Read-only. May be used in the GetHostInfo method only.
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00063

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Examples of Host Status Reason IDs

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00011

These examples show specific instances of the host status reason ID format, including the product name, version, and the hexadecimal representation of the reason GUID.

```KSC API
"1103/1.0.0.0/DBD500D3F6F04541910AD14C5CA47AE0"
"1093/1.0.0.0/D2152D6328CE4328BCB3192632670E58"
```

--------------------------------

### Get Kaspersky Product Update Information (KSC API)

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00013

Retrieves information about Kaspersky product updates, including the update ID and installation state. The installation state values are consistent with WUS update states.

```KSC API
"KLHST_VAPM_KL_UPDATE_ID" | paramBinary | Kaspersky product update ID.
"KLHST_VAPM_KL_INSTALL_STATE" | paramInt | Kaspersky product update install state (same values as for "KLHST_WUS_UPD_INSTALL_STATE").
```

--------------------------------

### Sample: Creating and Running a Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00061

Demonstrates the process of creating a new task and subsequently running it, providing a basic workflow for task automation.

```Python
Sample. Creating and running task.
```

--------------------------------

### Host Fixes Information

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00509

Functions to retrieve hotfixes installed on a host for a specific product and to get all hotfixes.

```C++
array GetHostfixesForProductOnHost (wstring strHostName, wstring strProductName, wstring strProductVersion)
// Returns an array of hotfixes for the specified host and product.

params GetAllHostfixes ()
// Returns information about installed products on the host.
```

--------------------------------

### Send Product Action via NagHstCtl

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00541_a84e64be3173dfab7f1abd62966316d36

Initiates a 'start' or 'stop' command for a specified product on a host. Requires product name, version, and action type (start/stop).

```C++
NagHstCtl::SendProductAction( wstring _szwProduct_, wstring _szwVersion_, int _nProductAction_ )
```

--------------------------------

### Get Host Products Information - KSC API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00509_a3462eed9c19e7c832333a09301a044aa

Retrieves information about installed products on a specified host. It takes the hostname as a parameter and returns a structure containing product names, versions, installation details, and connection information.

```KSC API
params HostGroup::GetHostProducts( wstring _strHostName )
```

--------------------------------

### Get Patch Parameters by Package ID

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00549_a1ef22ca5b2e06d80e0afdc8e9ce98aaf

Retrieves command line parameter values for a given patch package ID. This method is part of the PatchParameters class and is used to get installation commands for patches. It depends on the PatchParameters class for parameter value descriptions.

```KSC Open API
params PatchParameters::GetValuesByPkg(int _packageId_)
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00061

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get Hostfixes for Product on Host (KSC Open API)

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00509_a1423f62cba96232cd3ecba53a6dc8ae0

Retrieves an array of hotfixes installed on a specified host for a given product and version. The returned array is sorted by installation order. Requires host name, product name, and product version as input.

```KSC Open API
HostGroup::GetHostfixesForProductOnHost(wstring _strHostName, wstring _strProductName, wstring _strProductVersion)
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00454

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get Host Installed Products using InventoryApi

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00516_a0f464854ef7836666be83a7fede55279

Retrieves a list of software applications installed on a specified host using the InventoryApi. This method requires the host ID and can optionally take parameters for filtering the results. The returned data includes a list of software applications with their inventory attributes.

```KSC Open API
params InventoryApi::GetHostInvProducts(
    wstring _szwHostId_,
    params _pParams_ = NULL
)
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00063

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get Transmitted Data Size

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00325

Retrieves the number of transmitted data in bytes through GetNextFileChunk() since server start. This counter is always available.

```KSC API
"KLFTS_ST_TRANSMITTED_SIZE" | Number of transmitted data through GetNextFileChunk() in bytes since server start | paramLong | Always
```

--------------------------------

### Get Product Version Distribution

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00064

Details the distribution of installed protection products and their versions across the network. This is crucial for managing software updates and compatibility.

```API
DSHT_DATA entries:
* "product_name" (paramString) - Product name. See List of KLHST_WKS_PRODUCT_NAME and KLHST_WKS_PRODUCT_VERSION values for some products.
* "product_version" (paramString) - Product version. See List of KLHST_WKS_PRODUCT_NAME and KLHST_WKS_PRODUCT_VERSION values for some products.
```

```API
DSHT_DATA entries:
* "wstrName" (paramString) - Product name.
* "nCount" (paramInt) - Number of installations.
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00299

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get Downloaded Patch Data Chunk

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00591

Fetches a chunk of the downloaded patch body. It requires the request ID, a starting position, and the maximum size of the chunk to retrieve.

```C++
GetDownloadPatchDataChunk (wstring wstrRequestId, int nStartPos, int nSizeMax)
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00323

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00289

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get Kaspersky Product Patch Information (KSC API)

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00013

Provides details about Kaspersky product patches, including their global ID, LCID, and installation state.

```KSC API
"KLHST_VAPM_PRODUCT_PATCH_GLOBAL_ID" | paramInt | Global ID of vapm product patch.
"KLHST_VAPM_PRODUCT_PATCH_LCID" | paramInt | Vapm product patch LCID.
"KLHST_VAPM_PRODUCT_PATCH_INSTALL_STATE" | paramInt |  Vapm product patch install state (same values as for "KLHST_WUS_UPD_INSTALL_STATE").
```

--------------------------------

### iOS MDM Protocol Data for Certificates

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00090

Obtains data for installed certificates using the iOS MDM protocol. The function call KLIOSMDM::c_szwIosHstDevCertificates is utilized to get this information.

```C++
KLIOSMDM::c_szwIosHstDevCertificates
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00249

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00033

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get Supported LCIDs for Patch Prerequisites

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00591

Retrieves all supported LCIDs for the distributives or patches necessary to install a specified patch. It requires the patch's global ID and original LCID.

```C++
GetSupportedLcidsForPatchPrerequisites (long llPatchGlobalId, int nOriginalLcid,[out] array pLcids)
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00056

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get Software Products List - KSC Open API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00516

Retrieves a list of all installed software applications from the Kaspersky Security Center. This function is part of the InventoryApi interface.

```KSC Open API
params GetInvProductsList (params pParams=NULL)
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00454

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Get WUS Update Information (KSC API)

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00013

Fetches details about Windows Update Server (WUS) updates, including the update ID, revision number, and installation state.

```KSC API
"KLHST_WUS_UPD_UPDATE_ID" | paramString | WUS update ID.
"KLHST_WUS_UPD_REVISION_NUMBER" | paramString | WUS update revision number.
"KLHST_WUS_UPD_INSTALL_STATE" | paramInt | WUS update install state. For more information, see Software update installation state enum.
```

--------------------------------

### Get Task Start Event - KSC Open API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00582_a08058046543980b432df63ea0bd62ff3

Retrieves the event that should trigger a specific task. This function is part of the Tasks module and requires a task ID as input.

```KSC Open API
params Tasks::GetTaskStartEvent( wstring _strTask )
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00326

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get Host Software Products - KSC Open API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00516

Retrieves the software applications installed on a specific host. This method requires the host ID and is part of the InventoryApi interface.

```KSC Open API
params GetHostInvProducts (wstring szwHostId, params pParams=NULL)
```

--------------------------------

### Sample: Start Host Task by Name

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00213

Demonstrates how to initiate a task on a specific host by providing the task's name. This is a fundamental operation for task management.

```Python
Sample. Shows how you start host's task by name.
```

--------------------------------

### Get EULA IDs for Patch Prerequisites

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00591

Requests the set of EULA IDs required for installing a given patch. It takes the patch's global ID and LCID as input and returns an array of EULA IDs.

```C++
GetEulasIdsForPatchPrerequisites (long llPatchGlobalId, int nLCID,[out] array pEulasIds)
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00323

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00299

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Get EULA IDs for Patch Prerequisites using VapmControlApi

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00591_a69a3ee423f3453c127a595f3f3e4456f

Retrieves the set of EULA IDs required for installing a given patch. This method is part of the VapmControlApi and is used to manage EULA acceptance for software updates.

```C++
VapmControlApi::GetEulasIdsForPatchPrerequisites(
    long _llPatchGlobalId,
    int _nLCID,
    [out] array _pEulasIds
);
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00289

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Get Host Software Updates - KSC Open API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00516

Acquires the software application updates (patches) installed on a specified host. This function is provided by the InventoryApi class and requires the host ID.

```KSC Open API
params GetHostInvPatches (wstring szwHostId, params pParams=NULL)
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00033

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Get Task Start Event - HostTasks API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00513_a023bc3485316b1ffc63b6455b7d70397

Retrieves the event that should trigger a specific task. This method is part of the HostTasks class and requires server object ID and task identifier as parameters.

```KSC Open API
wstring _strSrvObjId_, wstring _strTask_
Get task start event.
Returns event which should run the task.

Parameters:
strSrvObjId | (wstring) server object ID that got from HostGroup.GetHostTasks
strTask | (wstring) "Tasks storage identifier of the task".

Returns:
(params) parameters of the event, see Task event filter attributes
```

--------------------------------

### Get Product Components for Host (KSC API)

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00509_a55ce7244805606f5973f9b68f43b3e7e

Retrieves an array of product components installed on a specified host for a given product and version. This function is part of the HostGroup class in the KSC Open API.

```KSC API
HostGroup::GetComponentsForProductOnHost(wstring _strHostName, wstring _strProductName, wstring _strProductVersion)
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00326

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Get Incompatible Apps Info using PackagesApi

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00548_a47ef941dff4c77fb16836f0767964622

Retrieves information about applications incompatible with a specific package. This method requires a package ID as input and returns details about incompatible apps, including whether they can be removed by the installer.

```C++
PackagesApi::GetIncompatibleAppsInfo(int _nPackageId_)
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00249

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Get All Hostfixes - KSC Open API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00509_a9d91aba0aada6d932cf2ee84710411bc

Retrieves all hotfixes installed across the network. This method returns detailed information about hotfix products and their associated data, including product names, versions, and hotfix IDs.

```KSC Open API
HostGroup::GetAllHostfixes()
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00213

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00056

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Format of Host Status Reason ID

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00011

This example illustrates the format of the host status reason ID, which includes the product name, version, and a hexadecimal representation of the reason GUID. This format is used for both KLHST_WKS_HSDP_REASON and KLHST_WKS_HSDP_ALLREASONS attributes.

```KSC API
<product>/<version>/<reason_guid_in_hex>
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00061

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### Get Host Inventory Patches using InventoryApi

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00516_a3887f0eac4a7e6f649eae1b652d0d18f

Retrieves a list of software application updates installed on a specified host using the InventoryApi. This method requires the host ID and can optionally take parameters for filtering the results.

```KSC Open API
params InventoryApi::GetHostInvPatches(
    wstring _szwHostId_,
    params _pParams_ = NULL
)
```

--------------------------------

### Sample: Enumerating, Querying, and Running Tasks

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00063

This sample covers the complete lifecycle of tasks: enumerating available tasks, querying their statistics, and initiating their execution.

```Python
Sample. Enumerating tasks, querying task statistics and running task.
```

--------------------------------

### File Transfer Resource Paths

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00394

Provides examples of HTTP GET and PUT requests for various file transfer operations using KSC Open API resource path prefixes. These include transferring update files, packages, and reports.

```HTTP
GET /FTUN/index/u0607g.xml HTTP/1.1
```

```HTTP
GET /FTFD/vfGBrkcAnt4Z_gpj9DY7N3 HTTP/1.1
```

```HTTP
GET /FTSF/klsctunnel HTTP/1.1
```

```HTTP
GET /KLRT/446baa1e-7b40-4d9e-9b16-142b652822f7.pdf HTTP/1.1
```

```HTTP
GET /FTDR/1b20a383-9ae7-49e3-b0ad-1e5edfe5926d HTTP/1.1
```

```HTTP
PUT /FTUR/1b20a383-9ae7-49e3-b0ad-1e5edfe5926d HTTP/1.1
```

```HTTP
GET /FTDH/some_relative_path HTTP/1.1
```

```HTTP
GET /KIPM/some_relative_path HTTP/1.1
```

```HTTP
GET /FPDS/some_relative_path HTTP/1.1
```

--------------------------------

### Update Installation Counts

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00354

Provides counts for update installations in various states: assigned, installing, installed, failed, and pending reboot. It also includes the installation state and associated task IDs.

```KSC API Parameters
nAssignedCount | paramInt | Number of installations where the update is assigned for installation by an existing task (but is not installing yet)
nInstallingCount | paramInt | Number of installations where the update is currently installing
nInstalledCount | paramInt | Number of installations where the update is successfully installed
nFailedCount | paramInt | Number of installations where the last known update installation state is "failed"
nNeedRebootCount | paramInt | Number of installations where the update installation is pending due to OS reboot request
nInstallState | paramInt | Update installation state, see Software update installation state enum
nTaskId | paramInt | Database ID of task having a rule to install the update directly
nTopTaskId | paramInt | Database ID of the top root group task having a rule to install the update directly
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00454

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### KSC API: Device Extra Data Structure Example

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00091

This snippet illustrates the structure of device extra data within the KSC API, including installed applications, managed applications, and configuration profiles. It shows how application identifiers, versions, and profile management details are represented.

```KSC API
+--- (paramArray)
    +---0 (paramParams)
        +---KLMDM_DEVICE_ID (paramInt) - Device identity.
        +---DEV_EX_DATA_APPL (paramArray) - Category with installed application list.
        |   +---0 (paramParams)
        |       +---AppIdentifier = (paramString)
        |       +---AppVersion = (paramString)
        |       +---AppShortVersion = (paramString)
        |       +---AppName = (paramString)
        |       +---AppBundleSize = (paramInt)
        +---DEV_EX_DATA_MNG_APPL (paramArray) - Category with installed managed application list.
        |   +---0 (paramParams)
        |       +---ManagedAppIdentifier = (paramString)
        |       +---ManagedAppStatus = (paramInt)
        |       +---ManagementFlags = (paramInt)
        |       +---UnusedRedCode = (paramString)
        +---DEV_EX_DATA_CFG_PROF (paramArray) - Category with installed configuration profile list.
            +---0 (paramParams)
                +---ProfDisplayName = (paramString)
                +---ProfIdentifier = (paramString)
                +---ProfIsManaged = (paramBool)
                +---ProfIsMdm = (paramBool)
                +---ProfUDID = (paramString)
```

--------------------------------

### LicenseKeys Class Members - KSC Open API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00759

This snippet lists the members of the LicenseKeys class within the KSC Open API. It includes methods for acquiring, adjusting, checking, downloading, enumerating, getting, installing, and uninstalling license keys, as well as SaaS license management.

```KSC Open API
AcquireKeyHosts(params pInData, array pFields, array pFieldsToOrder, params pOptions, int lTimeoutSec,[out] int lKeyCount,[out] wstring wstrIterator) | LicenseKeys |
AdjustKey(params pData) | LicenseKeys |
CheckIfSaasLicenseIsValid(params pInData, boolean bAsCurrent) | LicenseKeys |
DownloadKeyFiles(wstring wstrActivationCode) | LicenseKeys |
EnumKeys(array pFields, array pFieldsToOrder, params pOptions, int lTimeoutSec,[out] int lKeyCount,[out] wstring wstrIterator) | LicenseKeys |
GetKeyData(params pKeyInfo) | LicenseKeys |
InstallKey(params pKeyInfo) | LicenseKeys |
SaasTryToInstall(params pInData, boolean bAsCurrent) | LicenseKeys |
SaasTryToUninstall(boolean bCurrent) | LicenseKeys |
UninstallKey(params pKeyInfo) | LicenseKeys |
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00061

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Filter Endpoints by AMD Catalyst Install Manager Version

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00266

This query string filters endpoints that have 'AMD Catalyst Install Manager' installed, with a specific version and publisher. It excludes installations tagged with '11'.

```KSC API Query Language
&(KLHST_INVENTORY_PRODUCT_NAME="AMD Catalyst Install Manager")
(KLHST_INVENTORY_PRODUCT_DISPLAY_VERSION="1.22")(KLHST_INVENTORY_PRODUCT_PUBLISHER="ActiveState")
(KLHST_INVENTORY_INCLUDED_PRODUCT_TAG_NAME<>"11")
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00063

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Install KlAkOAPI Python Package

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00439

This command installs the KlAkOAPI Python package from a local tarball. Dependency packages are installed automatically. An optional argument '[samples]' can be added to install additional packages required for samples that interact with Active Directory.

```shell
>pip install KlAkOAPI-1.0.0.0.tar.gz
>pip install KlAkOAPI-1.0.0.0.tar.gz[samples]
```

--------------------------------

### Sample: Registering Update Agents

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00061

Demonstrates the process of registering update agents for hosts within a specific group, ensuring efficient distribution of updates.

```Python
Sample. Registering update agents for hosts in group.
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00323

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Set Preparation Start Time

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00030

Defines the start time for task preparation in milliseconds before the main task start. This is an optional parameter.

```API Configuration
"TASK_PREP_START" | paramInt | Optional | Start preparing for N milliseconds before the main start.
```

--------------------------------

### Sample: Registering Update Agents

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00063

Demonstrates the process of registering update agents for hosts within a specific group, ensuring efficient distribution of updates.

```Python
Sample. Registering update agents for hosts in group.
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00033

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Allow Shared Prerequisites Installation

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00548

Controls whether shared prerequisites can be installed for a package. It takes the package ID and a boolean flag to allow or disallow installation.

```C++
AllowSharedPrerequisitesInstallation (int nPackageId, boolean bAllow)
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00289

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Forbid Patch Installation using AKPatches API

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00482_aea57820625dd1ec427cc67fb7ff651d4

This method is used to forbid the installation of a specific patch. Once a patch is forbidden, no further notifications for its installation will be generated. It requires the patch identifier and reserved options as parameters.

```KSC Open API
AKPatches::ForbidPatch(wstring _szwPatchId_, params _parOptions_)
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00056

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Install Kaspersky License Key

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00528_af67ac6ced311efd847c6f0f078853b87

Installs a license key for an administration server. It requires the license serial number and an option to set it as the active license. The method handles license installation and validation.

```API
LicenseKeys::SaasTryToInstall(params _pInData, boolean _bAsCurrent)

Parameters:
  pInData: Input data container, mandatory. Attributes allowed:
    "KLLIC_SERIAL" - serial number of the license being checked, mandatory (paramString). The license must be placed in the license store before installing (see InstallKey).
  bAsCurrent: true if license should be installed in place of active one, false to install it as a reserved one.

Exceptions:
  Throws exception in case of error.

See also: SaasTryToUninstall
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00249

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Approve and Forbid Patches with AKPatches

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00482

The AKPatches class provides methods to control the installation of patches. ApprovePatch allows a patch to be installed, while ForbidPatch prevents its installation. Both methods accept a patch ID and optional parameters.

```C++
params ApprovePatch (wstring szwPatchId, params parOptions)
| Give approval to the patch on start installation.
```

```C++
params ForbidPatch (wstring szwPatchId, params parOptions)
| Forbid installation of the patch.
```

--------------------------------

### Update Installation Flags (Bitmask)

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00342

This section details the possible flags for update installations, which are combined as a bitmask. Each flag represents a specific condition or requirement for the update process, such as reboot behavior, administrative rights, and installation type.

```KSC API
1: Never request OS reboot
2: Can request OS reboot
4: OS reboot is always required
8: Gui is required
16: Local admin rights are required
32: Can only be installed as a patch for already installed product (not a full distributive)
64: Update installation needs current version uninstallation
128: Requires license validation
256: Brings minor impact to the system
512: Exclusive handling is required (cannot be installed together with other updates)
1024: Cannot be uninstalled
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00299

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Software Update Installation State Enum

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00284

Defines the possible states for software update installations within the KSC Open API. These states range from unknown and not applicable to installation in progress, completed, failed, or requiring a reboot.

```KSC API
0: Unknown
1: update is not applicable
2: update is applicable, but it has not yet been downloaded or installed
3: update is applicable to host, and the update is assigned to be installed there
4: update is being installed currently
5: update is installed
6: update installation has been failed
7: update has been installed but it is reboot required
8: update is applicable to host as a new major version, but it has not yet been downloaded or installed
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00326

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Sample: Enumerating License Keys

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00213

Provides a sample for listing all license keys currently managed by Kaspersky Security Center, essential for license management.

```Python
Sample. Enumerating license keys.
```

--------------------------------

### Migrate Data: Initialize File Upload URL

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00536_af74fc0aa50f44ba54320909968749d29

Retrieves the URL for uploading a zip archive containing exported data. This is part of a multi-step process for data migration, involving exporting data, obtaining an action GUID, checking the action state to get an upload URL, downloading the archive, initializing the upload URL via this method, uploading the archive, and finally importing the data.

```KSC Open API
wstring MigrationData::InitFileUpload ( )

```

--------------------------------

### Sample: Registering Update Agents

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00454

Demonstrates the process of registering update agents for hosts within a specific group, ensuring efficient distribution of updates.

```Python
Sample. Registering update agents for hosts in group.
```

--------------------------------

### System Update Installation Task

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00258

Details the KLSRV_TSK_SYSPATCH task for installing WUA updates and patches.

```KSC API
Component name | Task | Description | Reference
---|---|---|---
87 | KLSRV_TSK_SYSPATCH  |  |  WUA updates installation task ("KLSRV_TSK_SYSPATCH")
```

--------------------------------

### KLEVP_ND_BODY_FILTER Example

Source: https://support.kaspersky.com/help/KSC/13.2/KSCAPI/a00133

Example of a typical filtering attribute for KLEVP_ND_BODY_FILTER, specifically KLPRCI_newState and its possible values.

```KSC API
Typical filtering attribute for KLEVP_ND_BODY_FILTER is KLPRCI_newState, which can have one of the following values:
  * 0 - Task in memory is created (just read from disk) at the target computer.
  * 1 - Task in memory is running at the target computer.
  * 2 - Task in memory suspended at the target computer.
  * 3 - Task in memory failed at the target computer.
  * 4 - Task in memory completed at the target computer.
```
Tokens:
Raw