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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Adaptive Anomaly Control settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply application settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Request Body schema: application/json
object

Background scan

object

Backup

object

Local anti-virus database status notifications

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

Removable drives scan

object

Reports and Storage

object

Self-Defense

object

User support

object

Local Tasks

object

Interaction with user

object

Statuses

Responses

Request samples

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

Response samples

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

Get Behavior Detection settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Behavior Detection settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

Action

  • 0 - Delete file

  • 1 - Terminate the program

  • 2 - Block

  • 3 - Notify

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Cloud Control settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Request Body schema: application/json
groupsToBlock
Array of integers <uint32>

Blocked groups of services

mode
integer <int32>
Enum: 0 1 2 3

Mode

  • 0 - Not defined

  • 1 - Notify

  • 2 - Block selected services

  • 3 - Block all

servicesToBlock
Array of integers <uint32>

Blocked services

Responses

Request samples

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

Response samples

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

Get Scan from Context Menu task settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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; block if disinfection fails

  • 2 - Notify

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

iChecker Technology

useISwift
boolean

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Device Control settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

Logging Settings

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,
  • "fileOperationsMonitoringSettings": {
    },
  • "schedules": [
    ],
  • "trustedDevices": [
    ],
  • "wirelessSettings": {
    }
}

Response samples

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

Get device encryption settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply device encryption settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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 Application Control settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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 - Notify

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply scan exclusions settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Exploit Prevention settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

Action

  • 0 - Block operation

  • 1 - Notify

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

Action on threat detection

  • 0 - Disinfect; delete if disinfection fails

  • 1 - Disinfect; block if disinfection fails

  • 2 - Block

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

iChecker Technology

useISwift
boolean

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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 Host Intrusion Prevention settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Host Intrusion Prevention settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Kaspersky Anti Targeted Attack Platform settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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 Keyboard Authorization settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Keyboard Authorization settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Request Body schema: application/json
enableVirtualKeyboard
boolean

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

enabled
boolean

Enable

Responses

Request samples

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

Response samples

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

Get KSN settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

Statement

showStatisticsAgreement
boolean

Show Extended KSN mode Statement in application interface

object

Extended KSN mode Statement

useKlServers
boolean

Use KSN servers when KSN Proxy is not available

useKsnProxy
boolean

Use KSN Proxy

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 MDR settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply MDR settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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 Network Threat Protection settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Network Threat Protection settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

macSpoofingProtectionMode
integer <int32>
Enum: 0 1 2

MAC Spoofing Protection operating mode

  • 0 - Do not track MAC Spoofing attacks

  • 1 - Notify about all activity characteristic of MAC spoofing attacks

  • 2 - Block all activity characteristic of MAC spoofing attacks

Responses

Request samples

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

Response samples

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

Get Remediation Engine settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Remediation Engine settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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 Traffic Monitor settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Responses

Response samples

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

Apply Traffic Monitor settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Request Body schema: application/json
object

Monitored ports

object

Encrypted connections scan

Responses

Request samples

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

Response samples

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

Get Web Threat Protection settings

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

Request Body schema: application/json
object

Anti-Phishing settings

checkLinksWithAdwareDatabase
boolean

Check if links are listed in the database of advertising links

checkLinksWithRiskwareDatabase
boolean

Check if links are listed in the database of dangerous links

checkLinksWithSuspiciousUrlDatabase
boolean

Check the URL against the database of malicious URLs

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 download

  • 1 - Notify

  • 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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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

header Parameters
Big-Int-String-Format
string

If the parameter is specified as int64, the numbers in the response will have a string representation

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 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
}