Kaspersky Endpoint Security Web API (1.0.0)

Download OpenAPI specification:Download

This is Kaspersky Endpoint Security Web API documentation

Network Lists

Get a list of Adaptive Anomaly Control heuristics

Returns a list of Adaptive Anomaly Control heuristics groups

Responses

Response samples

Content type
application/json
{
  • "heuristicGroups": [
    ]
}

Documentation

Display this document

Display this document

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Password encryption

Encrypt user password for email notifications

Encrypt user password for email notifications

Request Body schema: application/json
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "password": "string"
}

Encrypt KLAdmin password

Encrypt KLAdmin password

Request Body schema: application/json
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "hash": "string",
  • "salt": "string"
}

Encrypt user password for proxy server

Encrypt user password for proxy server

Request Body schema: application/json
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "password": "string"
}

Encrypt user password for running task

Encrypt user password for running task

Request Body schema: application/json
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "password": "string"
}

General KES settings (by name)

Get AMSI Protection Provider settings

Responses

Response samples

Content type
application/json
{
  • "doNotUnpackArchivesWhenBig": true,
  • "doNotUnpackArchivesWhenBiggerThanMb": 0,
  • "enabled": true,
  • "scanArchives": true,
  • "scanInstallPackages": true,
  • "scanOfficeFiles": true,
  • "useIChecker": true,
  • "workMode": 1
}

Apply AMSI Protection Provider settings

Request Body schema: application/json
doNotUnpackArchivesWhenBig
boolean

"Do not unpack large compound files"

doNotUnpackArchivesWhenBiggerThanMb
integer <int32>

"Maximum file size (MB)"

enabled
boolean

"Enable"

scanArchives
boolean

"Scan archives"

scanInstallPackages
boolean

"Scan distribution packages"

scanOfficeFiles
boolean

"Scan files in Microsoft Office formats"

useIChecker
boolean

"Use iChecker Technology"

workMode
integer <int32>
Enum: 1 2 3

"Operating mode"

  • 1 - "AMSI Protection"

  • 2 - "IOAV Protection Provider"

  • 3 - "AMSI and IOAV Protection Providers"

Responses

Request samples

Content type
application/json
{
  • "doNotUnpackArchivesWhenBig": true,
  • "doNotUnpackArchivesWhenBiggerThanMb": 0,
  • "enabled": true,
  • "scanArchives": true,
  • "scanInstallPackages": true,
  • "scanOfficeFiles": true,
  • "useIChecker": true,
  • "workMode": 1
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Adaptive Anomaly Control settings

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "heuristicGroups": [
    ],
  • "messageTemplates": {
    }
}

Apply Adaptive Anomaly Control settings

Request Body schema: application/json
enabled
boolean

"Enable"

Array of objects

"Groups of rules"

object

"Templates"

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "heuristicGroups": [
    ],
  • "messageTemplates": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get application settings

Responses

Response samples

Content type
application/json
{
  • "additional": {
    },
  • "backgroundScan": {
    },
  • "backupStorage": {
    },
  • "basesValidity": {
    },
  • "compatibility": {
    },
  • "debugInformation": {
    },
  • "hsdpStatus": {
    },
  • "limitNotificationsInChildSession": true,
  • "notifications": {
    },
  • "operatingMode": {
    },
  • "passwordProtection": {
    },
  • "performance": {
    },
  • "promoSettings": {
    },
  • "proxy": {
    },
  • "quarantineStorage": {
    },
  • "removableDrivesScan": {
    },
  • "reports": {
    },
  • "selfDefense": {
    },
  • "support": {
    },
  • "syslogReports": {
    },
  • "taskControl": {
    },
  • "userInteraction": {
    },
  • "warnings": {
    }
}

Apply application settings

Request Body schema: application/json
object

"Advanced settings"

object

"Background scan"

object

"Backup"

object

"Local anti-virus database status notifications"

object

"Compatibility"

object

"Debug information"

object

"Computer status when settings are applied"

limitNotificationsInChildSession
boolean

"Don't show notifications in child's account"

object

"Notifications"

object

"Operating mode"

object

"Password protection"

object

"Performance"

object

"Promotional materials"

object

"Proxy server"

object

"Quarantine"

object

"Removable drives scan"

object

"Reports and Storage"

object

"Self-Defense"

object

"User support"

object

"Syslog reports"

object

"Local Tasks"

object

"Interaction with user"

object

"Showing application status"

Responses

Request samples

Content type
application/json
{
  • "additional": {
    },
  • "backgroundScan": {
    },
  • "backupStorage": {
    },
  • "basesValidity": {
    },
  • "compatibility": {
    },
  • "debugInformation": {
    },
  • "hsdpStatus": {
    },
  • "limitNotificationsInChildSession": true,
  • "notifications": {
    },
  • "operatingMode": {
    },
  • "passwordProtection": {
    },
  • "performance": {
    },
  • "promoSettings": {
    },
  • "proxy": {
    },
  • "quarantineStorage": {
    },
  • "removableDrivesScan": {
    },
  • "reports": {
    },
  • "selfDefense": {
    },
  • "support": {
    },
  • "syslogReports": {
    },
  • "taskControl": {
    },
  • "userInteraction": {
    },
  • "warnings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Behavior Detection settings

Responses

Response samples

Content type
application/json
{
  • "action": 0,
  • "enabled": true,
  • "sfAntiCryptor": {
    }
}

Apply Behavior Detection settings

Request Body schema: application/json
action
integer <int32>
Enum: 0 1 2 3

"Action"

  • 0 - "Delete file"

  • 1 - "Terminate the application"

  • 2 - "Block"

  • 3 - "Inform"

enabled
boolean

"Enable"

object

"Protection of shared folders against external encryption"

Responses

Request samples

Content type
application/json
{
  • "action": 0,
  • "enabled": true,
  • "sfAntiCryptor": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Cloud Control settings

Responses

Response samples

Content type
application/json
{
  • "enableTrafficStatistics": true,
  • "groupsToBlock": [
    ],
  • "mode": 0,
  • "servicesToBlock": [
    ]
}

Apply Cloud Control settings

Request Body schema: application/json
enableTrafficStatistics
boolean

"Enable traffic statistics"

groupsToBlock
Array of integers <uint32> [ items <uint32 > ]

"Blocked groups of services"

mode
integer <int32>
Enum: 0 1 2 3

"Mode"

  • 0 - "Not defined"

  • 1 - "Inform"

  • 2 - "Block selected services"

  • 3 - "Block all"

servicesToBlock
Array of integers <uint32> [ items <uint32 > ]

"Blocked services"

Responses

Request samples

Content type
application/json
{
  • "enableTrafficStatistics": true,
  • "groupsToBlock": [
    ],
  • "mode": 0,
  • "servicesToBlock": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Scan from Context Menu task settings

Responses

Response samples

Content type
application/json
{
  • "compoundFilesSettings": {
    },
  • "forceAdvancedDisinfection": true,
  • "heuristicLevel": 0,
  • "heuristicOnlyLevel": 0,
  • "scanAction": 0,
  • "scanFilter": 0,
  • "scanUnchangedObjects": true,
  • "timeLimits": {
    },
  • "useIChecker": true,
  • "useISwift": true
}

Apply Scan from Context Menu task settings

Request Body schema: application/json
object

"Scan of compound files"

forceAdvancedDisinfection
boolean

"Run Advanced Disinfection immediately"

heuristicLevel
integer <int32>
Enum: 0 1 2 3

"Use Heuristic analysis"

  • 0 - "Disabled"

  • 1 - "Light scan"

  • 2 - "Medium scan"

  • 3 - "Deep scan"

heuristicOnlyLevel
integer <int32>
Enum: 0 1 2 3

"Heuristic analysis"

  • 0 - "Disabled"

  • 1 - "Light scan"

  • 2 - "Medium scan"

  • 3 - "Deep scan"

scanAction
integer <int32>
Enum: 0 1 2

"Action on threat detection"

  • 0 - "Disinfect, delete if disinfection fails"

  • 1 - "Disinfect, inform if disinfection fails"

  • 2 - "Inform"

scanFilter
integer <int32>
Enum: 0 1 2

"File types"

  • 0 - "All files"

  • 1 - "Files scanned by format"

  • 2 - "Files scanned by extension"

scanUnchangedObjects
boolean

"Scan unchanged files"

object

"Limited scan duration"

useIChecker
boolean

"Use iChecker Technology"

useISwift
boolean

"Use iSwift Technology"

Responses

Request samples

Content type
application/json
{
  • "compoundFilesSettings": {
    },
  • "forceAdvancedDisinfection": true,
  • "heuristicLevel": 0,
  • "heuristicOnlyLevel": 0,
  • "scanAction": 0,
  • "scanFilter": 0,
  • "scanUnchangedObjects": true,
  • "timeLimits": {
    },
  • "useIChecker": true,
  • "useISwift": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Device Control settings

Responses

Response samples

Content type
application/json
{
  • "allowRequestAccess": true,
  • "antiBridgingSettings": {
    },
  • "blockMsg": "string",
  • "busAccessRules": [
    ],
  • "complaintAddress": "string",
  • "complaintMsg": "string",
  • "complaintSubject": "string",
  • "deviceAccessRules": [
    ],
  • "enabled": true,
  • "extendedBluetoothSettings": {
    },
  • "fileOperationsMonitoringSettings": {
    },
  • "notifyOnly": true,
  • "printerAdvancedSettings": {
    },
  • "schedules": [
    ],
  • "trustedDevices": [
    ],
  • "wirelessSettings": {
    }
}

Apply Device Control settings

Request Body schema: application/json
allowRequestAccess
boolean

"Allow request for temporary access"

object

"Anti-Bridging"

blockMsg
string

"Message template: blocking"

Array of objects

"Connection buses"

complaintAddress
string

"Recipient of the message to administrator"

complaintMsg
string

"Message to administrator"

complaintSubject
string

"Subject of the message to administrator"

Array of objects

"Types of devices"

enabled
boolean

"Enable"

object

"Advanced settings for Bluetooth devices"

object

"Logging Settings"

notifyOnly
boolean

"Inform about untrusted device connection or connection to an untrusted Wi-Fi network"

object

"Advanced printing settings for network printers"

Array of objects

"Schedule"

Array of objects

"Trusted devices"

object

"Wi-Fi settings"

Responses

Request samples

Content type
application/json
{
  • "allowRequestAccess": true,
  • "antiBridgingSettings": {
    },
  • "blockMsg": "string",
  • "busAccessRules": [
    ],
  • "complaintAddress": "string",
  • "complaintMsg": "string",
  • "complaintSubject": "string",
  • "deviceAccessRules": [
    ],
  • "enabled": true,
  • "extendedBluetoothSettings": {
    },
  • "fileOperationsMonitoringSettings": {
    },
  • "notifyOnly": true,
  • "printerAdvancedSettings": {
    },
  • "schedules": [
    ],
  • "trustedDevices": [
    ],
  • "wirelessSettings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get device encryption settings

Responses

Response samples

Content type
application/json
{
  • "bitlockerFixedDisksSettings": {
    },
  • "fixedDisksEncryptionTechnology": 0,
  • "kasperskyFdeFixedDisksSettings": {
    },
  • "kasperskyFdeRemovableDisksSettings": {
    }
}

Apply device encryption settings

Request Body schema: application/json
object

"BitLocker Drive Encryption"

fixedDisksEncryptionTechnology
integer <int32>
Enum: 0 1 2

"Encryption technology"

  • 0 - "Not specified"

  • 1 - "Kaspersky Disk Encryption"

  • 2 - "BitLocker Drive Encryption"

object

"Kaspersky Disk Encryption"

object

"Encryption of removable drives"

Responses

Request samples

Content type
application/json
{
  • "bitlockerFixedDisksSettings": {
    },
  • "fixedDisksEncryptionTechnology": 0,
  • "kasperskyFdeFixedDisksSettings": {
    },
  • "kasperskyFdeRemovableDisksSettings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Edr settings

Responses

Response samples

Content type
application/json
{
  • "cloudSandboxSettings": {
    },
  • "enabled": true,
  • "killchainSettings": { }
}

Apply Edr settings

Request Body schema: application/json
object

"Cloud Sandbox settings"

enabled
boolean

"Enable"

killchainSettings
object

"Threat development chain settings"

Responses

Request samples

Content type
application/json
{
  • "cloudSandboxSettings": {
    },
  • "enabled": true,
  • "killchainSettings": { }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get EdrExpertCloud settings

Responses

Response samples

Content type
application/json
{
  • "agreements": [
    ]
}

Apply EdrExpertCloud settings

Request Body schema: application/json
agreements
Array of strings

"Agreements"

Responses

Request samples

Content type
application/json
{
  • "agreements": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Application Control settings

Responses

Response samples

Content type
application/json
{
  • "blackListRules": [
    ],
  • "customCategories": [
    ],
  • "defaultDenyMode": true,
  • "enabled": true,
  • "id": 0,
  • "messageTemplates": {
    },
  • "moduleControl": 0,
  • "testMode": 0,
  • "whiteListRules": [
    ]
}

Apply Application Control settings

Request Body schema: application/json
Array of objects

"Denylist"

Array of objects

"Categories"

defaultDenyMode
boolean

"Default Deny"

enabled
boolean

"Enable"

id
integer <uint64>

"Category change count"

object

"Templates"

moduleControl
integer <int32>
Enum: 0 1 2

"Control DLL modules load"

  • 0 - "Shut down"

  • 1 - "Strict"

  • 2 - "Enable"

testMode
integer <int32>
Enum: 0 1 2

"Test rules"

  • 0 - "Apply rules"

  • 1 - "Test rules"

  • 2 - "Inform"

Array of objects

"Allowlist"

Responses

Request samples

Content type
application/json
{
  • "blackListRules": [
    ],
  • "customCategories": [
    ],
  • "defaultDenyMode": true,
  • "enabled": true,
  • "id": 0,
  • "messageTemplates": {
    },
  • "moduleControl": 0,
  • "testMode": 0,
  • "whiteListRules": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get scan exclusions settings

Responses

Response samples

Content type
application/json
{
  • "scanExclusionsAndTrustedZone": {
    },
  • "threats": {
    }
}

Apply scan exclusions settings

Request Body schema: application/json
object

"Scan exclusions and trusted applications"

object

"Types of detected objects"

Responses

Request samples

Content type
application/json
{
  • "scanExclusionsAndTrustedZone": {
    },
  • "threats": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Exploit Prevention settings

Responses

Response samples

Content type
application/json
{
  • "action": 0,
  • "enableSystemProcessesMemoryProtection": true,
  • "enabled": true
}

Apply Exploit Prevention settings

Request Body schema: application/json
action
integer <int32>
Enum: 0 1

"Action"

  • 0 - "Block operation"

  • 1 - "Inform"

enableSystemProcessesMemoryProtection
boolean

"Enable system process memory protection"

enabled
boolean

"Enable"

Responses

Request samples

Content type
application/json
{
  • "action": 0,
  • "enableSystemProcessesMemoryProtection": true,
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get File Threat Protection settings

Responses

Response samples

Content type
application/json
{
  • "compoundFilesSettings": {
    },
  • "detectBehavior": 0,
  • "enableShutdownProtection": true,
  • "enabled": true,
  • "heuristicLevel": 0,
  • "heuristicOnlyLevel": 0,
  • "scanAction": 0,
  • "scanFilter": 0,
  • "scanMode": 0,
  • "scanScope": [
    ],
  • "scanUnchangedObjects": true,
  • "sleepMode": {
    },
  • "useIChecker": true,
  • "useISwift": true
}

Apply File Threat Protection settings

Request Body schema: application/json
object

"Scan of compound files"

detectBehavior
integer <int32>
Enum: 0 1 2 3 4 5 6 7 8

"Action on threat detection (Kaspersky Internet Security local interface)"

  • 0 - "Log events"

  • 1 - "Ask user"

  • 2 - "Detect only"

  • 3 - "Postpone processing"

  • 4 - "Process the threat"

  • 5 - "Request permission from the application"

  • 6 - "Allow"

  • 7 - "Postpone processing, then ask the user"

  • 8 - "Postpone processing, then process the threat"

enableShutdownProtection
boolean

"Prevent infection on system restart"

enabled
boolean

"Enable"

heuristicLevel
integer <int32>
Enum: 0 1 2 3

"Use Heuristic analysis"

  • 0 - "Disabled"

  • 1 - "Light scan"

  • 2 - "Medium scan"

  • 3 - "Deep scan"

heuristicOnlyLevel
integer <int32>
Enum: 0 1 2 3

"Heuristic analysis"

  • 0 - "Disabled"

  • 1 - "Light scan"

  • 2 - "Medium scan"

  • 3 - "Deep scan"

scanAction
integer <int32>
Enum: 0 1 2 3

"Action on threat detection"

  • 0 - "Disinfect, delete if disinfection fails"

  • 1 - "Disinfect, block if disinfection fails"

  • 2 - "Block"

  • 3 - "Inform"

scanFilter
integer <int32>
Enum: 0 1 2

"File types"

  • 0 - "All files"

  • 1 - "Files scanned by format"

  • 2 - "Files scanned by extension"

scanMode
integer <int32>
Enum: 0 1 2 3 4 5

"Scan mode"

  • 0 - "Smart mode"

  • 1 - "On access and modification"

  • 2 - "On access"

  • 3 - "On execution"

  • 4 - "On modification"

  • 5 - "Smart 3"

Array of objects

"Scan scope"

scanUnchangedObjects
boolean

"Scan unchanged files"

object

"Pause task"

useIChecker
boolean

"Use iChecker Technology"

useISwift
boolean

"Use iSwift Technology"

Responses

Request samples

Content type
application/json
{
  • "compoundFilesSettings": {
    },
  • "detectBehavior": 0,
  • "enableShutdownProtection": true,
  • "enabled": true,
  • "heuristicLevel": 0,
  • "heuristicOnlyLevel": 0,
  • "scanAction": 0,
  • "scanFilter": 0,
  • "scanMode": 0,
  • "scanScope": [
    ],
  • "scanUnchangedObjects": true,
  • "sleepMode": {
    },
  • "useIChecker": true,
  • "useISwift": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get File Level Encryption settings

Responses

Response samples

Content type
application/json
{
  • "adminMessageTemplate": "string",
  • "complaintBodyTemplate": "string",
  • "complaintRecipient": "string",
  • "complaintSubject": "string",
  • "fixedDriveSettings": {
    },
  • "removableDriveSettings": {
    },
  • "secureWipeOriginals": true,
  • "sfxPasswordSettings": {
    }
}

Apply File Level Encryption settings

Request Body schema: application/json
adminMessageTemplate
string

"Template of an administrator's message"

complaintBodyTemplate
string

"Template of a user's message"

complaintRecipient
string

"Recipient in user's message template"

complaintSubject
string

"Subject in user's message template"

object

"File Level Encryption"

object

"Encryption of removable drives"

secureWipeOriginals
boolean

"Safely delete original files after encryption is complete"

object

"Encrypted package password settings"

Responses

Request samples

Content type
application/json
{
  • "adminMessageTemplate": "string",
  • "complaintBodyTemplate": "string",
  • "complaintRecipient": "string",
  • "complaintSubject": "string",
  • "fixedDriveSettings": {
    },
  • "removableDriveSettings": {
    },
  • "secureWipeOriginals": true,
  • "sfxPasswordSettings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get FileIntegrityMonitor settings

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "rules": [
    ]
}

Apply FileIntegrityMonitor settings

Request Body schema: application/json
enabled
boolean

"Enable File Integrity Monitor"

Array of objects

"Monitoring rules"

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Host Intrusion Prevention settings

Responses

Response samples

Content type
application/json
{
  • "firewall": {
    },
  • "hips": {
    }
}

Apply Host Intrusion Prevention settings

Request Body schema: application/json
object

"Firewall"

object

"Host Intrusion Prevention"

Responses

Request samples

Content type
application/json
{
  • "firewall": {
    },
  • "hips": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Kaspersky Anti Targeted Attack Platform settings

Responses

Response samples

Content type
application/json
{
  • "ServerAddress": "string",
  • "ServerPort": 0,
  • "enabled": true
}

Apply Kaspersky Anti Targeted Attack Platform settings

Request Body schema: application/json
ServerAddress
string

"Server address"

ServerPort
integer <uint16>

"Port"

enabled
boolean

"Enable"

Responses

Request samples

Content type
application/json
{
  • "ServerAddress": "string",
  • "ServerPort": 0,
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get KataConnector settings

Responses

Response samples

Content type
application/json
{
  • "clientPKSPassword": "string",
  • "clientPinnedCertificate": "string",
  • "enabled": true,
  • "eventTransferSettings": {
    },
  • "kataServers": [
    ],
  • "serverCertificate": "string",
  • "synchonizationPeriod": 0,
  • "timeout": 0,
  • "useClientPinnedCertificate": true,
  • "useProxy": true
}

Apply KataConnector settings

Request Body schema: application/json
clientPKSPassword
string <binary in Base64. See more https://en.wikipedia.org/wiki/Base64>

"Crypto-container password"

clientPinnedCertificate
string <binary in Base64. See more https://en.wikipedia.org/wiki/Base64>

"Client TLS certificate"

enabled
boolean

"Enable Endpoint Detection and Response (KATA)"

object

"Data transmission settings"

Array of objects

"Settings for connecting to KATA servers"

serverCertificate
string <binary in Base64. See more https://en.wikipedia.org/wiki/Base64>

"Server TLS certificate"

synchonizationPeriod
integer <int32>

"Send sync request to KATA server every (min)"

timeout
integer <uint32>

"Timeout (msec)"

useClientPinnedCertificate
boolean

"Use two-way authentication"

useProxy
boolean

"Connect using the proxy server if specified in the settings"

Responses

Request samples

Content type
application/json
{
  • "clientPKSPassword": "string",
  • "clientPinnedCertificate": "string",
  • "enabled": true,
  • "eventTransferSettings": {
    },
  • "kataServers": [
    ],
  • "serverCertificate": "string",
  • "synchonizationPeriod": 0,
  • "timeout": 0,
  • "useClientPinnedCertificate": true,
  • "useProxy": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Keyboard Authorization settings

Responses

Response samples

Content type
application/json
{
  • "enableVirtualKeyboard": true,
  • "enabled": true,
  • "usbDeviceAuthorizationMaxAttempts": 0,
  • "usbDeviceAuthorizationTimeout": 0
}

Apply Keyboard Authorization settings

Request Body schema: application/json
enableVirtualKeyboard
boolean

"Allow use of On-Screen Keyboard for authorization of USB devices"

enabled
boolean

"Enable"

usbDeviceAuthorizationMaxAttempts
integer <uint32>

"Maximum number of device authorization attempts"

usbDeviceAuthorizationTimeout
integer <uint32>

"Timeout when reaching the maximum number of attempts (minutes)"

Responses

Request samples

Content type
application/json
{
  • "enableVirtualKeyboard": true,
  • "enabled": true,
  • "usbDeviceAuthorizationMaxAttempts": 0,
  • "usbDeviceAuthorizationTimeout": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get KSN settings

Responses

Response samples

Content type
application/json
{
  • "agreedKsnMd5s": [
    ],
  • "enableCloudAVMode": true,
  • "ksnInaccessibleCloudAvModeSeverity": 0,
  • "ksnInaccessibleSeverity": 0,
  • "requestsAgreement": {
    },
  • "showStatisticsAgreement": true,
  • "statisticsAgreement": {
    },
  • "useKlServers": true,
  • "useKsnProxy": true
}

Apply KSN settings

Request Body schema: application/json
agreedKsnMd5s
Array of strings

"IDs of accepted KSN Statements"

enableCloudAVMode
boolean

"Enable Cloud mode"

ksnInaccessibleCloudAvModeSeverity
integer <int32>
Enum: 0 1 2

"Computer status when cloud mode is enabled, and KSN servers are unavailable"

  • 0 - "OK"

  • 1 - "Warning"

  • 2 - "Critical"

ksnInaccessibleSeverity
integer <int32>
Enum: 0 1 2

"Computer status when KSN servers are unavailable"

  • 0 - "OK"

  • 1 - "Warning"

  • 2 - "Critical"

object

"Kaspersky Security Network Statement"

showStatisticsAgreement
boolean

"Show Extended KSN mode Statement in application interface"

object

"Extended KSN mode Statement"

useKlServers
boolean

"Use Kaspersky Security Network servers if the KSN proxy server is unavailable"

useKsnProxy
boolean

"Use Administration Server as a KSN proxy server"

Responses

Request samples

Content type
application/json
{
  • "agreedKsnMd5s": [
    ],
  • "enableCloudAVMode": true,
  • "ksnInaccessibleCloudAvModeSeverity": 0,
  • "ksnInaccessibleSeverity": 0,
  • "requestsAgreement": {
    },
  • "showStatisticsAgreement": true,
  • "statisticsAgreement": {
    },
  • "useKlServers": true,
  • "useKsnProxy": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get LogInspector settings

Responses

Response samples

Content type
application/json
{
  • "customRules": {
    },
  • "enabled": true,
  • "predefinedRules": {
    }
}

Apply LogInspector settings

Request Body schema: application/json
object

"Custom rules"

enabled
boolean

"Enable Log Inspection"

object

"Predefined rules"

Responses

Request samples

Content type
application/json
{
  • "customRules": {
    },
  • "enabled": true,
  • "predefinedRules": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get MDR settings

Responses

Response samples

Content type
application/json
{
  • "configuration": "string",
  • "enabled": true
}

Apply MDR settings

Request Body schema: application/json
configuration
string <binary in Base64. See more https://en.wikipedia.org/wiki/Base64>

"configuration file BLOB"

enabled
boolean

"Enable"

Responses

Request samples

Content type
application/json
{
  • "configuration": "string",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Mail Threat Protection settings

Responses

Response samples

Content type
application/json
{
  • "attachmentsFilterSettings": {
    },
  • "compoundFilesSettings": {
    },
  • "detectBehavior": 0,
  • "enabled": true,
  • "heuristicLevel": 0,
  • "heuristicOnlyLevel": 0,
  • "outlookPluginSettings": {
    },
  • "scanAction": 0,
  • "scanDirection": 0,
  • "scanMailTraffic": true
}

Apply Mail Threat Protection settings

Request Body schema: application/json
object

"Attachment filter"

object

"Scan of compound files"

detectBehavior
integer <int32>
Enum: 0 1 2 3 4 5 6 7 8

"Action on threat detection (Kaspersky Internet Security local interface)"

  • 0 - "Log events"

  • 1 - "Ask user"

  • 2 - "Detect only"

  • 3 - "Postpone processing"

  • 4 - "Process the threat"

  • 5 - "Request permission from the application"

  • 6 - "Allow"

  • 7 - "Postpone processing, then ask the user"

  • 8 - "Postpone processing, then process the threat"

enabled
boolean

"Enable"

heuristicLevel
integer <int32>
Enum: 0 1 2 3

"Use Heuristic analysis"

  • 0 - "Disabled"

  • 1 - "Light scan"

  • 2 - "Medium scan"

  • 3 - "Deep scan"

heuristicOnlyLevel
integer <int32>
Enum: 0 1 2 3

"Heuristic analysis"

  • 0 - "Disabled"

  • 1 - "Light scan"

  • 2 - "Medium scan"

  • 3 - "Deep scan"

object

"Connect Microsoft Outlook extension"

scanAction
integer <int32>
Enum: 0 1 2

"Action on threat detection"

  • 0 - "Disinfect, delete if disinfection fails"

  • 1 - "Disinfect, block if disinfection fails"

  • 2 - "Block"

scanDirection
integer <int32>
Enum: 0 1

"Protection scope"

  • 0 - "Incoming and outgoing messages"

  • 1 - "Incoming messages only"

scanMailTraffic
boolean

"Scan POP3, SMTP, NNTP, and IMAP traffic"

Responses

Request samples

Content type
application/json
{
  • "attachmentsFilterSettings": {
    },
  • "compoundFilesSettings": {
    },
  • "detectBehavior": 0,
  • "enabled": true,
  • "heuristicLevel": 0,
  • "heuristicOnlyLevel": 0,
  • "outlookPluginSettings": {
    },
  • "scanAction": 0,
  • "scanDirection": 0,
  • "scanMailTraffic": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get NetworkIsolation settings

Responses

Response samples

Content type
application/json
{
  • "exclusionRules": [
    ],
  • "isolationDuration": 0
}

Apply NetworkIsolation settings

Request Body schema: application/json
Array of objects

"Network isolation rules"

isolationDuration
integer <uint32>

"Duration of isolation"

Responses

Request samples

Content type
application/json
{
  • "exclusionRules": [
    ],
  • "isolationDuration": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Network Threat Protection settings

Responses

Response samples

Content type
application/json
{
  • "attackFilters": [
    ],
  • "banTimeout": 0,
  • "enableBan": true,
  • "enabled": true,
  • "excludeIPs": [
    ],
  • "excludesWithPorts": [
    ],
  • "macSpoofingProtectionMode": 0,
  • "notifyOnly": true
}

Apply Network Threat Protection settings

Request Body schema: application/json
Array of objects

"Attack filter"

banTimeout
integer <uint32>

"Block the attacking computer for"

enableBan
boolean

"Add the attacking computer to the list of blocked computers"

enabled
boolean

"Enable"

Array of objects

"Exclusions"

Array of objects

"Exclusions for ports"

macSpoofingProtectionMode
integer <int32>
Enum: 0 1 2

"MAC spoofing protection mode"

  • 0 - "Do not track MAC spoofing"

  • 1 - "Inform"

  • 2 - "Block"

notifyOnly
boolean

"Inform"

Responses

Request samples

Content type
application/json
{
  • "attackFilters": [
    ],
  • "banTimeout": 0,
  • "enableBan": true,
  • "enabled": true,
  • "excludeIPs": [
    ],
  • "excludesWithPorts": [
    ],
  • "macSpoofingProtectionMode": 0,
  • "notifyOnly": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Prevention settings

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "rules": [
    ],
  • "workMode": 0
}

Apply Prevention settings

Request Body schema: application/json
enabled
boolean

"Enable"

Array of objects

"Execution prevention rules"

workMode
integer <int32>
Enum: 0 1

"Operating mode"

  • 0 - "Active"

  • 1 - "Audit"

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "rules": [
    ],
  • "workMode": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Remediation Engine settings

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Apply Remediation Engine settings

Request Body schema: application/json
enabled
boolean

"Enable"

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Sandbox settings

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "response": {
    },
  • "standaloneSandboxSettings": {
    }
}

Apply Sandbox settings

Request Body schema: application/json
enabled
boolean

"Enable"

object

"Action on threat detection"

object

"Kaspersky Sandbox settings"

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "response": {
    },
  • "standaloneSandboxSettings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Traffic Monitor settings

Responses

Response samples

Content type
application/json
{
  • "customRootCA": {
    },
  • "portsMonitoring": {
    },
  • "trafficDecoding": {
    }
}

Apply Traffic Monitor settings

Request Body schema: application/json
object

"User certificates"

object

"Monitored ports"

object

"Encrypted connections scan"

Responses

Request samples

Content type
application/json
{
  • "customRootCA": {
    },
  • "portsMonitoring": {
    },
  • "trafficDecoding": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Web Threat Protection settings

Responses

Response samples

Content type
application/json
{
  • "antiphishingSettings": {
    },
  • "checkLinksWithAdwareDatabase": true,
  • "checkLinksWithRiskwareDatabase": true,
  • "checkLinksWithSuspiciousUrlDatabase": true,
  • "enabled": true,
  • "heuristicLevel": 0,
  • "heuristicOnlyLevel": 0,
  • "scanAction": 0,
  • "trustedUrlSettings": {
    },
  • "urlAdvisorSettings": {
    },
  • "webCheckerMode": 0
}

Apply Web Threat Protection settings

Request Body schema: application/json
object

"Anti-Phishing settings"

checkLinksWithAdwareDatabase
boolean

"Check the web address against the database of advertising web addresses"

checkLinksWithRiskwareDatabase
boolean

"Check the web address against the database of dangerous web addresses"

checkLinksWithSuspiciousUrlDatabase
boolean

"Check the web address against the database of malicious web addresses"

enabled
boolean

"Enable"

heuristicLevel
integer <int32>
Enum: 0 1 2 3

"Use Heuristic analysis"

  • 0 - "Disabled"

  • 1 - "Light scan"

  • 2 - "Medium scan"

  • 3 - "Deep scan"

heuristicOnlyLevel
integer <int32>
Enum: 0 1 2 3

"Heuristic analysis"

  • 0 - "Disabled"

  • 1 - "Light scan"

  • 2 - "Medium scan"

  • 3 - "Deep scan"

scanAction
integer <int32>
Enum: 0 1 2

"Action on threat detection"

  • 0 - "Block"

  • 1 - "Inform"

  • 2 - "Ask user"

object

"Trusted web addresses"

object

"Link check"

webCheckerMode
integer <int32>
Enum: 0 1 2

"Scan mode"

  • 0 - "Default"

  • 1 - "Maximum performance"

  • 2 - "Maximum protection"

Responses

Request samples

Content type
application/json
{
  • "antiphishingSettings": {
    },
  • "checkLinksWithAdwareDatabase": true,
  • "checkLinksWithRiskwareDatabase": true,
  • "checkLinksWithSuspiciousUrlDatabase": true,
  • "enabled": true,
  • "heuristicLevel": 0,
  • "heuristicOnlyLevel": 0,
  • "scanAction": 0,
  • "trustedUrlSettings": {
    },
  • "urlAdvisorSettings": {
    },
  • "webCheckerMode": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Get Web Control settings

Responses

Response samples

Content type
application/json
{
  • "advancedSettings": {
    },
  • "complaintBodyTemplate": "string",
  • "complaintRecipient": "string",
  • "complaintSubject": "string",
  • "defaultVerdict": 0,
  • "denyMessageTemplate": "string",
  • "enabled": true,
  • "rules": [
    ],
  • "schedules": [
    ],
  • "urlCategories": [
    ],
  • "warnMessageTemplate": "string"
}

Apply Web Control settings

Request Body schema: application/json
object

"Advanced settings"

complaintBodyTemplate
string

"Template of a message to administrator"

complaintRecipient
string

"Recipient of the message to administrator"

complaintSubject
string

"Subject of the message to administrator"

defaultVerdict
integer <int32>
Enum: 0 1 2

"Default rule"

  • 0 - "Allow"

  • 1 - "Block"

  • 2 - "Warn"

denyMessageTemplate
string

"Message template: blocking"

enabled
boolean

"Enable"

Array of objects

"Rules"

Array of objects

"Schedules"

Array of objects

"Groups of addresses"

warnMessageTemplate
string

"Message template: warning"

Responses

Request samples

Content type
application/json
{
  • "advancedSettings": {
    },
  • "complaintBodyTemplate": "string",
  • "complaintRecipient": "string",
  • "complaintSubject": "string",
  • "defaultVerdict": 0,
  • "denyMessageTemplate": "string",
  • "enabled": true,
  • "rules": [
    ],
  • "schedules": [
    ],
  • "urlCategories": [
    ],
  • "warnMessageTemplate": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Application tasks

Get application tasks

Get application tasks

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

Control Integrity Check task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Get Integrity Check task settings

Responses

Response samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": { }
}

Apply Integrity Check task settings

Request Body schema: application/json
object
object
settings
object

Responses

Request samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": { }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Control KscServerBinding task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Control Rollback task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Get Rollback task settings

Responses

Response samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": { }
}

Apply Rollback task settings

Request Body schema: application/json
object
object
settings
object

Responses

Request samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": { }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Control Scan_IdleScan task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Get Scan_IdleScan task settings

Responses

Response samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Apply Scan_IdleScan task settings

Request Body schema: application/json
object
object
object

Responses

Request samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Control Full Scan task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Get Full Scan task settings

Responses

Response samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Apply Full Scan task settings

Request Body schema: application/json
object
object
object

Responses

Request samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Control Custom Scan task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Get Custom Scan task settings

Responses

Response samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Apply Custom Scan task settings

Request Body schema: application/json
object
object
object

Responses

Request samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Control Scan_Qscan task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Get Scan_Qscan task settings

Responses

Response samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Apply Scan_Qscan task settings

Request Body schema: application/json
object
object
object

Responses

Request samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Control Critical Areas Scan task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Get Critical Areas Scan task settings

Responses

Response samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Apply Critical Areas Scan task settings

Request Body schema: application/json
object
object
object

Responses

Request samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}

Control Updater task

Request Body schema: application/json
action
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{ }

Get Updater task settings

Responses

Response samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Apply Updater task settings

Request Body schema: application/json
object
object
object

Responses

Request samples

Content type
application/json
{
  • "run_as": {
    },
  • "schedule": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "errorCode": 0
}