KSC Open API
Kaspersky Security Center API description
ListTags Class Reference

Interface allows to acquire and manage tags to various KSC objects. More...

List of all members.

Public Member Functions

array GetTags (array pIdArray, params pParams=NULL)
 Get tag values for specified list items.
 SetTags (array pListItemsTags, params pParams=NULL)
 Set tag values for specified list items.
array GetAllTags (params pParams=NULL)
 Get all existing tag values.
 AddTag (wstring szwTagValue, params pParams=NULL)
 Add a new tag.
 DeleteTags2 (array pTagValue, params pParams=NULL)
 Delete tags.
 RenameTag (wstring szwOldTagValue, wstring szwNewTagValue, params pParams=NULL)
 Rename a tag.

Detailed Description

Interface allows to acquire and manage tags to various KSC objects.

Homogeneous objects, i.e. objects of the same type, can be considered as a list. To work with such list, it is convenient to be able to associate string values called tags with list items. The tags for each list are completely independent of each other.

Each instance of the ListTags interface is associated with a specific list. It is needed to specify ListTagID as Instance (see Request Format of the request) The set of possible ListTagIDs is described in The set of lists that support tags

See also Python code with use of KlAkOAPI Python package below:

    server = KlAkOAPI.AdmServer.KlAkAdmServer.Create("https://ksc.example.com:13299", "username", "password", verify = False)
    oTagsControl = KlAkOAPI.ListTags.KlAkListTags(server, 'HostsTags')
    # enumerate all tags of the network list
    oTags = oTagsControl.GetAllTags(None).RetVal()
    if oTags != None and len(oTags) > 0:
        for oObj in oTags:
           print("Tag: ", oObj)