Documentation Powered by ReDoc

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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/aacHeuristics
http://localhost:6782/kes/v1/aacHeuristics

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "heuristicGroups":
    [
    ]
}

Documentation

Display this document

Display this document

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/api-docs
http://localhost:6782/kes/v1/api-docs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/passwords/emailNotification/encrypt
http://localhost:6782/kes/v1/passwords/emailNotification/encrypt

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "string"
}

Encrypt KLAdmin password

Encrypt KLAdmin password

Request Body schema: application/json
password
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/passwords/klAdmin/encrypt
http://localhost:6782/kes/v1/passwords/klAdmin/encrypt

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "hash": "string",
  • "salt": "string"
}

Encrypt user password for proxy server

Encrypt user password for proxy server

Request Body schema: application/json
password
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/passwords/proxyServer/encrypt
http://localhost:6782/kes/v1/passwords/proxyServer/encrypt

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "string"
}

Encrypt user password for running task

Encrypt user password for running task

Request Body schema: application/json
password
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/passwords/taskRunAs/encrypt
http://localhost:6782/kes/v1/passwords/taskRunAs/encrypt

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "string"
}

General KES settings (by name)

Get AMSI Protection Provider settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/AMSI
http://localhost:6782/kes/v1/settings/AMSI

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/AMSI
http://localhost:6782/kes/v1/settings/AMSI

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Adaptive Anomaly Control settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/AdaptiveAnomaliesControl
http://localhost:6782/kes/v1/settings/AdaptiveAnomaliesControl

Response samples

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

Apply Adaptive Anomaly Control settings

Request Body schema: application/json
enabled
boolean

Enable

heuristicGroups
Array of objects

Groups of rules

messageTemplates
object

Templates

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/AdaptiveAnomaliesControl
http://localhost:6782/kes/v1/settings/AdaptiveAnomaliesControl

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get application settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/ApplicationSettings
http://localhost:6782/kes/v1/settings/ApplicationSettings

Response samples

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

Apply application settings

Request Body schema: application/json
backgroundScan
object

Background scan

backupStorage
object

Backup

basesValidity
object

Local anti-virus database status notifications

debugInformation
object

Debug information

hsdpStatus
object

Computer status when settings are applied

limitNotificationsInChildSession
boolean

Don't show notifications in child's account

notifications
object

Notifications

operatingMode
object

Operating mode

passwordProtection
object

Password protection

performance
object

Performance

promoSettings
object

Promotional materials

proxy
object

Proxy server

quarantineStorage
object

Quarantine

removableDrivesScan
object

Removable drives scan

reports
object

Reports and Storage

selfDefense
object

Self-Defense

support
object

User support

taskControl
object

Local Tasks

userInteraction
object

Interaction with user

warnings
object

Showing application status

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/ApplicationSettings
http://localhost:6782/kes/v1/settings/ApplicationSettings

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Behavior Detection settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/BehaviourDetection
http://localhost:6782/kes/v1/settings/BehaviourDetection

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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 - Notify

enabled
boolean

Enable

sfAntiCryptor
object

Protection of shared folders against external encryption

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/BehaviourDetection
http://localhost:6782/kes/v1/settings/BehaviourDetection

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Cloud Control settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/CloudControl
http://localhost:6782/kes/v1/settings/CloudControl

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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>

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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/CloudControl
http://localhost:6782/kes/v1/settings/CloudControl

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Scan from Context Menu task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/ContextScan
http://localhost:6782/kes/v1/settings/ContextScan

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
compoundFilesSettings
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

timeLimits
object

Limited scan duration

useIChecker
boolean

iChecker Technology

useISwift
boolean

iSwift Technology

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/ContextScan
http://localhost:6782/kes/v1/settings/ContextScan

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Device Control settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/DeviceControl
http://localhost:6782/kes/v1/settings/DeviceControl

Response samples

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

Apply Device Control settings

Request Body schema: application/json
allowRequestAccess
boolean

Allow request for temporary access

antiBridgingSettings
object

Anti-Bridging

blockMsg
string

Message template: blocking

busAccessRules
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

deviceAccessRules
Array of objects

Types of devices

enabled
boolean

Enable

fileOperationsMonitoringSettings
object

Logging Settings

schedules
Array of objects

Schedule

trustedDevices
Array of objects

Trusted devices

wirelessSettings
object

Wi-Fi settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/DeviceControl
http://localhost:6782/kes/v1/settings/DeviceControl

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get device encryption settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/DiskEncryption
http://localhost:6782/kes/v1/settings/DiskEncryption

Response samples

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

Apply device encryption settings

Request Body schema: application/json
bitlockerFixedDisksSettings
object

BitLocker Drive Encryption

fixedDisksEncryptionTechnology
integer <int32>
Enum: 0 1 2

Encryption technology

  • 0 - Not specified

  • 1 - Kaspersky Disk Encryption

  • 2 - BitLocker Drive Encryption

kasperskyFdeFixedDisksSettings
object

Kaspersky Disk Encryption

kasperskyFdeRemovableDisksSettings
object

Encryption of removable drives

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/DiskEncryption
http://localhost:6782/kes/v1/settings/DiskEncryption

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Edr settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/Edr
http://localhost:6782/kes/v1/settings/Edr

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "killchainSettings": { }
}

Apply Edr settings

Request Body schema: application/json
enabled
boolean

Enable

killchainSettings
object

Threat development chain settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/Edr
http://localhost:6782/kes/v1/settings/Edr

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "killchainSettings": { }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Application Control settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/EnterpriseApplicationControl
http://localhost:6782/kes/v1/settings/EnterpriseApplicationControl

Response samples

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

Apply Application Control settings

Request Body schema: application/json
blackListRules
Array of objects

Denylist

customCategories
Array of objects

Categories

defaultDenyMode
boolean

Default Deny

enabled
boolean

Enable

id
integer <uint64>

Category change count

messageTemplates
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

whiteListRules
Array of objects

Allowlist

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/EnterpriseApplicationControl
http://localhost:6782/kes/v1/settings/EnterpriseApplicationControl

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get scan exclusions settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/ExclusionsSettings
http://localhost:6782/kes/v1/settings/ExclusionsSettings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "scanExclusionsAndTrustedZone":
    {
    },
  • "threats":
    {
    }
}

Apply scan exclusions settings

Request Body schema: application/json
scanExclusionsAndTrustedZone
object

Scan exclusions and trusted applications

threats
object

Types of detected objects

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/ExclusionsSettings
http://localhost:6782/kes/v1/settings/ExclusionsSettings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "scanExclusionsAndTrustedZone":
    {
    },
  • "threats":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Exploit Prevention settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/ExploitPrevention
http://localhost:6782/kes/v1/settings/ExploitPrevention

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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 - Notify

enableSystemProcessesMemoryProtection
boolean

Enable system process memory protection

enabled
boolean

Enable

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/ExploitPrevention
http://localhost:6782/kes/v1/settings/ExploitPrevention

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get File Threat Protection settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/FileAv
http://localhost:6782/kes/v1/settings/FileAv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
compoundFilesSettings
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

scanScope
Array of objects

Scan scope

scanUnchangedObjects
boolean

Scan unchanged files

sleepMode
object

Pause task

useIChecker
boolean

iChecker Technology

useISwift
boolean

iSwift Technology

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/FileAv
http://localhost:6782/kes/v1/settings/FileAv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get File Level Encryption settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/FileEncryption
http://localhost:6782/kes/v1/settings/FileEncryption

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

fixedDriveSettings
object

File Level Encryption

removableDriveSettings
object

Encryption of removable drives

secureWipeOriginals
boolean

Safely delete original files after encryption is complete

sfxPasswordSettings
object

Encrypted package password settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/FileEncryption
http://localhost:6782/kes/v1/settings/FileEncryption

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Host Intrusion Prevention settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/Hips
http://localhost:6782/kes/v1/settings/Hips

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "firewall":
    {
    },
  • "hips":
    {
    }
}

Apply Host Intrusion Prevention settings

Request Body schema: application/json
firewall
object

Firewall

hips
object

Host Intrusion Prevention

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/Hips
http://localhost:6782/kes/v1/settings/Hips

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "firewall":
    {
    },
  • "hips":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Kaspersky Anti Targeted Attack Platform settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/KATA
http://localhost:6782/kes/v1/settings/KATA

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/KATA
http://localhost:6782/kes/v1/settings/KATA

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Keyboard Authorization settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/KeyboardAuthorization
http://localhost:6782/kes/v1/settings/KeyboardAuthorization

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/KeyboardAuthorization
http://localhost:6782/kes/v1/settings/KeyboardAuthorization

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get KSN settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/Ksn
http://localhost:6782/kes/v1/settings/Ksn

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

requestsAgreement
object

Statement

showStatisticsAgreement
boolean

Show Extended KSN mode Statement in application interface

statisticsAgreement
object

Extended KSN mode Statement

useKlServers
boolean

Use KSN servers when KSN Proxy is not available

useKsnProxy
boolean

Use KSN Proxy

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/Ksn
http://localhost:6782/kes/v1/settings/Ksn

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get MDR settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/MDR
http://localhost:6782/kes/v1/settings/MDR

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/MDR
http://localhost:6782/kes/v1/settings/MDR

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "configuration": "string",
  • "enabled": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Mail Threat Protection settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/MailAv
http://localhost:6782/kes/v1/settings/MailAv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
attachmentsFilterSettings
object

Attachment filter

compoundFilesSettings
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

outlookPluginSettings
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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/MailAv
http://localhost:6782/kes/v1/settings/MailAv

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get NetworkIsolation settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/NetworkIsolation
http://localhost:6782/kes/v1/settings/NetworkIsolation

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "isolationDuration": 0,
  • "rules":
    [
    ]
}

Apply NetworkIsolation settings

Request Body schema: application/json
isolationDuration
integer <uint32>

Duration of isolation

rules
Array of objects

Isolation rules

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/NetworkIsolation
http://localhost:6782/kes/v1/settings/NetworkIsolation

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "isolationDuration": 0,
  • "rules":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Network Threat Protection settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/NetworkThreatProtection
http://localhost:6782/kes/v1/settings/NetworkThreatProtection

Response samples

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

Apply Network Threat Protection settings

Request Body schema: application/json
attackFilters
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

excludeIPs
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

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/NetworkThreatProtection
http://localhost:6782/kes/v1/settings/NetworkThreatProtection

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Prevention settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/Prevention
http://localhost:6782/kes/v1/settings/Prevention

Response samples

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

Apply Prevention settings

Request Body schema: application/json
enabled
boolean

Enable

rules
Array of objects

Execution prevention rules

workMode
integer <int32>
Enum: 0 1

Operating mode

  • 0 - Active

  • 1 - Audit

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/Prevention
http://localhost:6782/kes/v1/settings/Prevention

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Remediation Engine settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/RemediationEngine
http://localhost:6782/kes/v1/settings/RemediationEngine

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true
}

Apply Remediation Engine settings

Request Body schema: application/json
enabled
boolean

Enable

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/RemediationEngine
http://localhost:6782/kes/v1/settings/RemediationEngine

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Sandbox settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/Sandbox
http://localhost:6782/kes/v1/settings/Sandbox

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "response":
    {
    },
  • "standaloneSandboxSettings":
    {
    }
}

Apply Sandbox settings

Request Body schema: application/json
enabled
boolean

Enable

response
object

Action on threat detection

standaloneSandboxSettings
object

Kaspersky Sandbox settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/Sandbox
http://localhost:6782/kes/v1/settings/Sandbox

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "response":
    {
    },
  • "standaloneSandboxSettings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Traffic Monitor settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/TrafficMonitorSettings
http://localhost:6782/kes/v1/settings/TrafficMonitorSettings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "portsMonitoring":
    {
    },
  • "trafficDecoding":
    {
    }
}

Apply Traffic Monitor settings

Request Body schema: application/json
portsMonitoring
object

Monitored ports

trafficDecoding
object

Encrypted connections scan

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/TrafficMonitorSettings
http://localhost:6782/kes/v1/settings/TrafficMonitorSettings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "portsMonitoring":
    {
    },
  • "trafficDecoding":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Web Threat Protection settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/WebAv
http://localhost:6782/kes/v1/settings/WebAv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
antiphishingSettings
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 download

  • 1 - Notify

  • 2 - Ask user

trustedUrlSettings
object

Trusted web addresses

urlAdvisorSettings
object

Link check

webCheckerMode
integer <int32>
Enum: 0 1 2

Scan mode

  • 0 - Default

  • 1 - Maximum performance

  • 2 - Maximum protection

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/WebAv
http://localhost:6782/kes/v1/settings/WebAv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Get Web Control settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/settings/WebControl
http://localhost:6782/kes/v1/settings/WebControl

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
advancedSettings
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

rules
Array of objects

Rules

schedules
Array of objects

Schedules

urlCategories
Array of objects

Groups of addresses

warnMessageTemplate
string

Message template: warning

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/settings/WebControl
http://localhost:6782/kes/v1/settings/WebControl

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Application tasks

Get application tasks

Get application tasks

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks
http://localhost:6782/kes/v1/tasks

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tasks":
    [
    ]
}

Control BitlockerProtection task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/BitlockerProtection
http://localhost:6782/kes/v1/tasks/BitlockerProtection

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Control Integrity Check task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/IntegrityCheck
http://localhost:6782/kes/v1/tasks/IntegrityCheck

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Integrity Check task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks/IntegrityCheck/settings
http://localhost:6782/kes/v1/tasks/IntegrityCheck/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings": { }
}

Apply Integrity Check task settings

Request Body schema: application/json
run_as
object
schedule
object
settings
object

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/IntegrityCheck/settings
http://localhost:6782/kes/v1/tasks/IntegrityCheck/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings": { }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Control Rollback task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Rollback
http://localhost:6782/kes/v1/tasks/Rollback

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Rollback task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks/Rollback/settings
http://localhost:6782/kes/v1/tasks/Rollback/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings": { }
}

Apply Rollback task settings

Request Body schema: application/json
run_as
object
schedule
object
settings
object

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Rollback/settings
http://localhost:6782/kes/v1/tasks/Rollback/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings": { }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Control Scan_IdleScan task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_IdleScan
http://localhost:6782/kes/v1/tasks/Scan_IdleScan

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Scan_IdleScan task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks/Scan_IdleScan/settings
http://localhost:6782/kes/v1/tasks/Scan_IdleScan/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Apply Scan_IdleScan task settings

Request Body schema: application/json
run_as
object
schedule
object
settings
object

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_IdleScan/settings
http://localhost:6782/kes/v1/tasks/Scan_IdleScan/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Control Full Scan task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_My_Computer
http://localhost:6782/kes/v1/tasks/Scan_My_Computer

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Full Scan task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks/Scan_My_Computer/settings
http://localhost:6782/kes/v1/tasks/Scan_My_Computer/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Apply Full Scan task settings

Request Body schema: application/json
run_as
object
schedule
object
settings
object

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_My_Computer/settings
http://localhost:6782/kes/v1/tasks/Scan_My_Computer/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Control Custom Scan task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_Objects
http://localhost:6782/kes/v1/tasks/Scan_Objects

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Custom Scan task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks/Scan_Objects/settings
http://localhost:6782/kes/v1/tasks/Scan_Objects/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Apply Custom Scan task settings

Request Body schema: application/json
run_as
object
schedule
object
settings
object

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_Objects/settings
http://localhost:6782/kes/v1/tasks/Scan_Objects/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Control Scan_Qscan task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_Qscan
http://localhost:6782/kes/v1/tasks/Scan_Qscan

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Scan_Qscan task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks/Scan_Qscan/settings
http://localhost:6782/kes/v1/tasks/Scan_Qscan/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Apply Scan_Qscan task settings

Request Body schema: application/json
run_as
object
schedule
object
settings
object

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_Qscan/settings
http://localhost:6782/kes/v1/tasks/Scan_Qscan/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Control Critical Areas Scan task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_Startup
http://localhost:6782/kes/v1/tasks/Scan_Startup

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Critical Areas Scan task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks/Scan_Startup/settings
http://localhost:6782/kes/v1/tasks/Scan_Startup/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Apply Critical Areas Scan task settings

Request Body schema: application/json
run_as
object
schedule
object
settings
object

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Scan_Startup/settings
http://localhost:6782/kes/v1/tasks/Scan_Startup/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}

Control Updater task

Request Body schema: application/json
action
string

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Updater
http://localhost:6782/kes/v1/tasks/Updater

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "action": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Updater task settings

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

get /kes/v1/tasks/Updater/settings
http://localhost:6782/kes/v1/tasks/Updater/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Apply Updater task settings

Request Body schema: application/json
run_as
object
schedule
object
settings
object

Responses

200

OK

403

Access denied. You do not have permission to perform the action.

500

Unexpected error

post /kes/v1/tasks/Updater/settings
http://localhost:6782/kes/v1/tasks/Updater/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "run_as":
    {
    },
  • "schedule":
    {
    },
  • "settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "description": "string",
  • "errorCode": 0
}