Download OpenAPI specification:Download
This is a KES web api documentation
Returns list of AAC heuristics groups
OK
You don't have permission to access
Unexpected error
Development server
Return list of all host devices
OK
You don't have permission to access
Unexpected error
Development server
Return list of all host principals
OK
You don't have permission to access
Unexpected error
Development server
Return application control category tree
You don't have permission to access
Unexpected error
Development server
Returns list of applications in required folder.
Before the request you need to subscribe to the EventSource with name 'folderapps'.
The first request for particular folder should be with only query parameter 'path', only after that you can request data for retrive.
Accessible column names:
file_name - File;
file_hash - File hash code;
folder_path - Folder path;
certificate_issuer - Issuer;
certificate_subject - Subject;
certificate_thumbprint - Thumbprint;
kl_category_name - Kl category;
kl_category_id - Kl category id (Not represintation on UI);
original_file_name - File name;
file_version - File version;
program_name - Application name;
program_version - Application version;
program_vendor - Vendor;
columns | Array of strings Columns to retrieve (Array of columns names separated by comma) |
end | integer End record position to retrieve |
filter-columns | Array of strings Columns filtered by (Array of columns names separated by comma) |
filter-string | string Filter string |
path | string Path to the folder to get from |
recursive | boolean Include subfolders (default is false) |
start | integer Start record position to retrieve |
OK
You don't have permission to access
Unexpected error
Development server
Returns list of started applications.
Before the request you need to subscribe to the EventSource with name 'startedapps'.
The first request for started applications should be without any query parameters, only after that you can request data for retrive.
Accessible column names:
file_name - File;
file_hash - File hash code;
folder_path - Folder path;
certificate_issuer - Issuer;
certificate_subject - Subject;
certificate_thumbprint - Thumbprint;
kl_category_name - Kl category;
kl_category_id - Kl category id (Not represintation on UI);
original_file_name - File name;
file_version - File version;
program_name - Application name;
program_version - Application version;
program_vendor - Vendor;
columns | Array of strings Columns to retrieve (Array of columns names separated by comma) |
end | integer End record position to retrieve |
filter-columns | Array of strings Columns filtered by (Array of columns names separated by comma) |
filter-string | string Filter string |
start | integer Start record position to retrieve |
OK
You don't have permission to access
Unexpected error
Development server
Return component list
OK
You don't have permission to access
Unexpected error
Development server
If query isn't specified returns json array of available event names that you can to subscribe, if query is specified you gonna subscribe to events
subscribe | Array of strings Array of event names separated by commas that you wanna subscribe |
OK
You don't have permission to access
Unexpected error
Development server
Request KSN Agreement accept by user
OK
You don't have permission to access
Unexpected error
Development server
View KSN Agreement in maximized window
OK
You don't have permission to access
Unexpected error
Development server
Return principal list by sid list
sids | Array of strings |
OK
You don't have permission to access
Unexpected error
Development server
Returns count of rows in FileAvReportTable
command | string |
OK
You don't have permission to access
Unexpected error
Development server
Returns report records preset with filters in query
command | string |
OK
You don't have permission to access
Unexpected error
Development server
Gets any product settings by id
id required | integer ID of desired settings struct in hexadecimal format (begins without 0x) |
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Sets any product settings by id
id required | integer ID of desired settings struct in hexadecimal format (begins without 0x) |
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Gets any product settings by id
id required | integer ID of desired settings struct in hexadecimal format (begins without 0x) |
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Sets any product settings by id
id required | integer ID of desired settings struct in hexadecimal format (begins without 0x) |
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
NOTE: operation can be performed asynchronously.
task_id required | string Task's id (profile name for product) |
action | string |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
task_id required | string Task's id (profile name for product) |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
task_id required | string Task's id (profile name for product) |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
doNotUnpackArchivesWhenBig | boolean |
doNotUnpackArchivesWhenBiggerThanMb | integer <int32> |
enabled | boolean |
scanArchives | boolean |
scanInstallPackages | boolean |
scanOfficeFiles | boolean |
useIChecker | boolean |
workMode | integer <uint32> |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
enabled | boolean |
heuristicGroups | Array of objects |
messageTemplates | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
backgroundScan | object |
backupStorage | object |
basesValidity | object |
debugInformation | object |
hsdpStatus | object |
notifications | object |
operatingMode | object |
passwordProtection | object |
performance | object |
proxy | object |
removableDrivesScan | object |
reports | object |
selfDefense | object |
support | object |
taskControl | object |
userInteraction | object |
warnings | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
action | integer <uint32> |
enabled | boolean |
sfAntiCryptor | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
groupsToBlock | Array of integers <uint32> |
mode | integer <uint32> |
servicesToBlock | Array of integers <uint32> |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
compoundFilesSettings | object |
forceAdvancedDisinfection | boolean |
heuristicLevel | integer <uint32> |
scanAction | integer <uint32> |
scanFilter | integer <uint32> |
scanUnchangedObjects | boolean |
timeLimits | object |
useIChecker | boolean |
useISwift | boolean |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
allowRequestAccess | boolean |
antiBridgingSettings | object |
blockMsg | string |
busAccessRules | Array of objects |
complaintAddress | string |
complaintMsg | string |
complaintSubject | string |
deviceAccessRules | Array of objects |
enabled | boolean |
fileOperationsMonitoringSettings | object |
schedules | Array of objects |
trustedDevices | Array of objects |
wirelessSettings | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
bitlockerFixedDisksSettings | object |
fixedDisksEncryptionTechnology | integer <uint32> |
kasperskyFdeFixedDisksSettings | object |
kasperskyFdeRemovableDisksSettings | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
blackListRules | Array of objects |
customCategories | Array of objects |
defaultDenyMode | boolean |
enabled | boolean |
id | integer <uint64> |
messageTemplates | object |
moduleControl | integer <uint32> |
testMode | integer <uint32> |
whiteListRules | Array of objects |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
scanExclusionsAndTrustedZone | object |
threats | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
action | integer <uint32> |
enableSystemProcessesMemoryProtection | boolean |
enabled | boolean |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
compoundFilesSettings | object |
enabled | boolean |
heuristicLevel | integer <uint32> |
scanAction | integer <uint32> |
scanFilter | integer <uint32> |
scanMode | integer <uint32> |
scanScope | Array of objects |
scanUnchangedObjects | boolean |
sleepMode | object |
useIChecker | boolean |
useISwift | boolean |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
adminMessageTemplate | string |
complaintBodyTemplate | string |
complaintRecipient | string |
complaintSubject | string |
fixedDriveSettings | object |
removableDriveSettings | object |
secureWipeOriginals | boolean |
sfxPasswordSettings | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
firewall | object |
hips | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
ServerAddress | string |
ServerPort | integer <uint16> |
enabled | boolean |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
enableVirtualKeyboard | boolean |
enabled | boolean |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
agreedKsnMd5s | Array of strings |
enableCloudAVMode | boolean |
ksnInaccessibleCloudAvModeSeverity | integer <uint32> |
ksnInaccessibleSeverity | integer <uint32> |
requestsAgreement | object |
statisticsAgreement | object |
useKlServers | boolean |
useKsnProxy | boolean |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
attachmentsFilterSettings | object |
compoundFilesSettings | object |
enabled | boolean |
heuristicLevel | integer <uint32> |
outlookPluginSettings | object |
scanAction | integer <uint32> |
scanDirection | integer <uint32> |
scanMailTraffic | boolean |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
banTimeout | integer <uint32> |
enableBan | boolean |
enabled | boolean |
excludeIPs | Array of objects |
macSpoofingProtectionMode | integer <uint32> |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
enabled | boolean |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
portsMonitoring | object |
trafficDecoding | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
antiphishingSettings | object |
checkLinksWithSuspiciousUrlDatabase | boolean |
enabled | boolean |
heuristicLevel | integer <uint32> |
scanAction | integer <uint32> |
trustedUrlSettings | object |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
Big-Int-String-Format | string If the param is specified than int64 numbers in response will have a string representation |
advancedSettings | object |
complaintBodyTemplate | string |
complaintRecipient | string |
complaintSubject | string |
defaultVerdict | integer <uint32> |
denyMessageTemplate | string |
enabled | boolean |
rules | Array of objects |
schedules | Array of objects |
urlCategories | Array of objects |
warnMessageTemplate | string |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
NOTE: operation can be performed asynchronously.
action | string |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
run_as | object |
schedule | object |
settings | object |
OK
You don't have permission to access
Unexpected error
Development server
NOTE: operation can be performed asynchronously.
action | string |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
run_as | object |
schedule | object |
settings | object |
OK
You don't have permission to access
Unexpected error
Development server
NOTE: operation can be performed asynchronously.
action | string |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
run_as | object |
schedule | object |
settings | object |
OK
You don't have permission to access
Unexpected error
Development server
NOTE: operation can be performed asynchronously.
action | string |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
run_as | object |
schedule | object |
settings | object |
OK
You don't have permission to access
Unexpected error
Development server
NOTE: operation can be performed asynchronously.
action | string |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
run_as | object |
schedule | object |
settings | object |
OK
You don't have permission to access
Unexpected error
Development server
NOTE: operation can be performed asynchronously.
action | string |
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
OK
You don't have permission to access
Unexpected error
Development server
Description of the method is not specified
run_as | object |
schedule | object |
settings | object |
OK
You don't have permission to access
Unexpected error
Development server