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:8080/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:8080/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:8080/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:8080/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:8080/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:8080/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

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

200

OK

403

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

500

Unexpected error

get /kes/v1/settings/AMSI
http://localhost:8080/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

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 Office formats

useIChecker
boolean

iChecker Technology

workMode
integer <int32>
Enum: 1 2 3

Operating mode

  • 1 - AMSI Protection Provider

  • 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:8080/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

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

200

OK

403

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

500

Unexpected error

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

Response samples

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

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:8080/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

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

200

OK

403

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

500

Unexpected error

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

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "backgroundScan":
    {
    },
  • "backupStorage":
    {
    },
  • "basesValidity":
    {
    },
  • "debugInformation":
    {
    },
  • "hsdpStatus":
    {
    },
  • "notifications":
    {