KSC Open API
Kaspersky Security Center API description
Product backend commands

KSC server may communicate with product backends via product backend commands. To receive and process product backend commands client should subscribe to "KLSRV_EV_PROD_BACKEND_CMD" event using event polling mechanism (Event polling usage). Client which is able to process or forward product backend commands is also referred as "Service console".


"KLSRV_EV_PROD_BACKEND_CMD" event fields

AttributeTypeDescription
CMD_IDparamStringcommand id
CMD_PROD_NAMEparamStringproduct name
CMD_PROD_VERSIONparamStringproduct version

Subscription to "KLSRV_EV_PROD_BACKEND_CMD" event must always contain filter with non-empty values for "CMD_PROD_NAME" and "CMD_PROD_VERSION", otherwise subscription will be rejected.

When client receives "KLSRV_EV_PROD_BACKEND_CMD" it should use ServiceNwcCommandProvider methods to get command parameters and provide with command results.

To be able to process product backend commands client must have Execute right to "FUNC_AREA_PRODUCT_INTEGRATION".


Command description

Each backend command has following attributes:

AttributeTypeDescription
CMD_NAMEparamStringCommand name
CMD_PROD_NAMEparamStringProduct name
CMD_PROD_VERSIONparamStringProduct version
CMD_PARAMSparamsCommand-specific parameters


Command errors

Each command may finish with error. Service console passes error as (paramParams) container with following fields:

AttributeTypeDescriptionOptional
CMD_ERR_STR_IDparamStringOne of known errors defined in this document. This is the only field understood and analyzed by KSC server. See errors list belowOptional
CMD_ERR_ORIGINATOR_IDparamStringError originator identity. Value chosen arbitrarily by error originator and aims to help to identify problem source
CMD_ERR_IDparamIntError id as defined by error originator. Not understood by KSC, but may be understood by command initiatorOptional
CMD_ERR_DESCRparamStringHuman-readable error description
CMD_ERR_LOC_DESCRparamStringHuman-readable localized error descriptionOptional
CMD_ERR_FNAMEparamStringSource file where error generatedOptional
CMD_ERR_LNUMBERparamIntLine number where error generatedOptional

List of common known errors:

Error string idDescription
ERR_NO_BACKENDCommand cannot be routed to product backend
ERR_NOT_SUPPORTEDCommand not supported by product backend
ERR_UNKNOWN_TOKENAuthorization token not provided or unknown to product backend
ERR_EXPIRED_TOKENAuthorization token expired


See also:
ServiceNwcCommandProvider
List of supported backend commands
Event polling usage