Kaspersky Endpoint Security Web API (1.0.0)

Download OpenAPI specification:Download

This is Kaspersky Endpoint Security Web API documentation

Network Lists

Get a list of Adaptive Anomaly Control heuristics

Returns a list of Adaptive Anomaly Control heuristics groups

Responses

Response samples

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

Documentation

Display this document

Display this document

Responses

Response samples

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

Password encryption

Encrypt user password for email notifications

Encrypt user password for email notifications

Request Body schema: application/json
password
string

Responses

Request samples

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

Response samples

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

Encrypt KLAdmin password

Encrypt KLAdmin password

Request Body schema: application/json
password
string

Responses

Request samples

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

Response samples

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

Encrypt user password for proxy server

Encrypt user password for proxy server

Request Body schema: application/json
password
string

Responses

Request samples

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

Response samples

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

Encrypt user password for running task

Encrypt user password for running task

Request Body schema: application/json
password
string

Responses

Request samples

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

Response samples

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

General KES settings (by name)

Get AMSI Protection Provider settings

Responses

Response samples

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

Apply AMSI Protection Provider settings

Request Body schema: application/json
doNotUnpackArchivesWhenBig
boolean

"Do not unpack large compound files"

doNotUnpackArchivesWhenBiggerThanMb
integer <int32>

"Maximum file size (MB)"

enabled
boolean

"Enable"

scanArchives
boolean

"Scan archives"

scanInstallPackages
boolean

"Scan distribution packages"

scanOfficeFiles
boolean

"Scan files in Microsoft Office formats"

useIChecker
boolean

"Use iChecker Technology"

workMode
integer <int32>
Enum: 1 2 3

"Operating mode"

  • 1 - "AMSI Protection"

  • 2 - "IOAV Protection Provider"

  • 3 - "AMSI and IOAV Protection Providers"

Responses

Request samples

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

Response samples

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

Get Adaptive Anomaly Control settings

Responses

Response samples

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

Apply Adaptive Anomaly Control settings

Request Body schema: application/json
enabled
boolean

"Enable"

Array of objects

"Groups of rules"

object

"Templates"

Responses

Request samples

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

Response samples

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

Get application settings

Responses

Response samples

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

Apply application settings

Request Body schema: application/json
object

"Advanced settings"

object

"Background scan"

object

"Backup"

object

"Local anti-virus database status notifications"

object

"Compatibility"

object

"Debug information"

object

"Computer status when settings are applied"

limitNotificationsInChildSession
boolean

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

object

"Notifications"

object

"Operating mode"

object

"Password protection"

object

"Performance"

object

"Promotional materials"

object

"Proxy server"

object

"Quarantine"

object

"Removable drives scan"

object

"Reports and Storage"

object

"Self-Defense"

object

"User support"

object

"Syslog reports"

object

"Local Tasks"

object

"Interaction with user"

object

"Showing application status"

Responses

Request samples

Content type
application/json
{
  • "additional": {
    },
  • "backgroundScan": {
    },
  • "backupStorage": {
    },
  • "basesValidity": {
    },
  • "compatibility": {
    },
  • "debugInformation": {
    },
  • "hsdpStatus": {
    },
  • "limitNotificationsInChildSession": true,
  • "notifications": {