Contents
Services
This section contains descriptions of services provided by Kaspersky Industrial CyberSecurity for Networks API.
AssetProvider
Kaspersky Industrial CyberSecurity for Networks asset provider service.
Defined in
This service is defined in the asset_provider_service.proto file.
Syntax
service AssetProvider
{
rpc GetAssetsUpdatedAfter(AssetsUpdatedAfterRequest) returns(stream Asset);
}
Service methods
The AssetProvider service has the following service methods.
AssetProvider service methods
Name |
Request message |
Response message |
Description |
|---|---|---|---|
|
|
Returns a list of assets registered in Kaspersky Industrial CyberSecurity for Networks and updated after the time, specified in AssetsUpdatedAfterRequest method. |
ConfigurationProvider
Kaspersky Industrial CyberSecurity for Networks configuration provider service.
Defined in
This service is defined in the configuration_provider_service.proto file.
Syntax
service ConfigurationProvider
{
rpc GetKscConfiguration(google.protobuf.Empty) returns(KscConfiguration);
rpc GetConfigurationMetadata(google.protobuf.Empty) returns(ConfigurationMetadata);
rpc GetPlcConfiguration(google.protobuf.Empty) returns(stream PlcConfiguration);
rpc GetProtocolConfiguration(HashIdValue) returns(stream ProtocolConfiguration);
rpc GetTagsForPlc(HashIdValue) returns(stream TagDescriptor);
rpc GetTagsForProtocol(HashIdValue) returns(stream TagDescriptor);
rpc GetEventDescriptors(google.protobuf.Empty) returns(stream EventDescriptor);
}
Service methods
The ConfigurationProvider service has the following service methods.
ConfigurationProvider service methods
Name |
Request message |
Response message |
Description |
|---|---|---|---|
|
|
Returns configuration for Kaspersky Security Center agent. |
|
|
|
Returns current Kaspersky Industrial CyberSecurity for Networks configuration metadata. |
|
|
|
|
Returns a list of PLCs and information about them. |
|
|
Returns configuration for protocols of the specified PLC. |
|
|
|
Returns tag descriptors for the specified PLC. |
|
|
|
Returns tag descriptors for the specified protocol. |
|
|
|
|
Returns descriptors for event types. |
Remarks
If no configuration is loaded into Kaspersky Industrial CyberSecurity for Networks, calling ConfigurationProvider service methods results in an error.
DictionaryProvider
Dictionary provider service. This service provides dictionary values used by Kaspersky Industrial CyberSecurity for Networks.
Defined in
This service is defined in the dictionary_provider_service.proto file.
Syntax
service DictionaryProvider
{
rpc GetDictionary(DictionaryRequest) returns(stream google.protobuf.StringValue);
}
Service methods
The DictionaryProvider service has the following service methods.
DictionaryProvider service methods
Name |
Request message |
Response message |
Description |
|---|---|---|---|
|
|
Returns a stream of values in a specified dictionary. |
EventProvider
Event provider service.
Defined in
This service is defined in the event_provider_service.proto file.
Syntax
service EventProvider
{
rpc GetItem(EventId) returns(Event);
rpc RequestItems(Filter) returns(Cookie);
rpc GetItems(ItemsRequest) returns(stream Event);
rpc GetRequestState(Cookie) returns(RequestStateResponse);
rpc CancelItemsRequest(Cookie) returns(google.protobuf.Empty);
rpc GetItemsById(ItemsByIdRequest) returns(stream Event);
}
Service methods
The EventProvider service has the following service methods.
EventProvider service methods
Name |
Request message |
Response message |
Description |
|---|---|---|---|
|
Returns a single event according to its identifier. Receives the event identifier and returns an event with the specified identifier. |
||
|
Makes an asynchronous request for a specific number of events in a certain time span. Receives the parameters of an event request and returns a request cookie. |
||
|
|
Returns the results of an asynchronous request. Receives a request cookie and range parameters, and returns a stream of events. After the events are received, you must make a |
|
|
Returns the state of an asynchronous request. Receives a request cookie and returns the status of the request. |
||
|
|
Cancels the processing of an asynchronous request (if processing is not yet complete) and frees resources allocated for the request. Receives a request cookie. |
|
|
|
Returns a specified number of events starting from a certain event (but not including this event). Receives request parameters (filter, identifier of the starting event, and maximum number of events) and returns a stream of events. |
EventRegistrar
Service that registers events in Kaspersky Industrial CyberSecurity for Networks.
Defined in
This service is defined in the event_registrar_service.proto file.
Syntax
service EventRegistrar
{
rpc PostGenericEvents(stream NewGenericEvent) returns(google.protobuf.Empty);
}
Service methods
The EventRegistrar service has the following service methods.
EventRegistrar service methods
Name |
Request message |
Response message |
Description |
|---|---|---|---|
|
|
|
Registers one or more events. Receives a stream of events. |
ProductFacade
Kaspersky Industrial CyberSecurity for Networks version provider service.
Defined in
This service is defined in the product_facade_service.proto file.
Syntax
service ProductFacade
{
rpc GetVersion(google.protobuf.Empty) returns (Version);
}
Service methods
The ProductFacade service has the following service methods.
ProductFacade service methods
Name |
Request message |
Response message |
Description |
|---|---|---|---|
|
|
Returns version information. |
TagNotifier
Service that handles requests with tag change events from Kaspersky Industrial CyberSecurity for Networks. This service must be implemented on the client side.
Defined in
This service is defined in the tag_notifier_service.proto file.
Syntax
service TagNotifier
{
rpc OnNewTags(stream TagEvent) returns(google.protobuf.Empty);
}
Service methods
The TagNotifier service has the following service methods.
TagNotifier service methods
Name |
Request message |
Response message |
Description |
|---|---|---|---|
|
|
|
This method is called when a message with a tag change event is received. Receives a stream of tag events (tags and operation types). |
TagProvider
Service that provides information about tags and handles subscription to tag change events.
Defined in
This service is defined in the tag_provider_service.proto file.
Syntax
service TagProvider
{
rpc SubscribeTagNotifier(SubscriptionRequest) returns(Cookie);
rpc UnsubscribeNotifier(Cookie) returns(google.protobuf.Empty);
rpc GetTags(TagsRequest) returns(stream Tag);
}
Service methods
TagProvider service has the following service methods.
TagProvider service methods
Name |
Request message |
Response message |
Description |
|---|---|---|---|
|
Subscribes to tag change events. Receives subscription settings (address and filter) and returns the subscription cookie. |
||
|
|
Removes an existing subscription to tag change events. Receives a request cookie. |
|
|
|
Returns a collection of tags. Receives tag request and returns a continuous stream of tags. |