Documentation Powered by ReDoc

KES Web API (1.0.0)

Download OpenAPI specification:Download

API Support: support@example.com URL: http://www.example.com/support License: Apache 2.0 Terms of Service

This is a KES web api documentation

Private API (for internal usage only) - Network Lists

Get Adaptive Anomalies Control heuristics info list

Returns list of AAC heuristics groups

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/aacheuristics

Development server

http://localhost:8080/kes/private/v1/aacheuristics

Response samples

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

Get devices info list

Return list of all host devices

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/devices

Development server

http://localhost:8080/kes/private/v1/devices

Response samples

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

Get principals info list

Return list of all host principals

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/principals

Development server

http://localhost:8080/kes/private/v1/principals

Response samples

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

Private API (for internal usage only) - EAC

Get application control category tree

Return application control category tree

Responses

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/appctrlcategorytree

Development server

http://localhost:8080/kes/private/v1/appctrlcategorytree

Response samples

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

Get list applications in folder

Returns list of applications in required folder.

Before the request you need to subscribe to the EventSource with name 'folderapps'.

The first request for particular folder should be with only query parameter 'path', only after that you can request data for retrive.

Accessible column names:

  • file_name - File;

  • file_hash - File hash code;

  • folder_path - Folder path;

  • certificate_issuer - Issuer;

  • certificate_subject - Subject;

  • certificate_thumbprint - Thumbprint;

  • kl_category_name - Kl category;

  • kl_category_id - Kl category id (Not represintation on UI);

  • original_file_name - File name;

  • file_version - File version;

  • program_name - Application name;

  • program_version - Application version;

  • program_vendor - Vendor;

query Parameters
columns
Array of strings

Columns to retrieve (Array of columns names separated by comma)

end
integer

End record position to retrieve

filter-columns
Array of strings

Columns filtered by (Array of columns names separated by comma)

filter-string
string

Filter string

path
string

Path to the folder to get from

recursive
boolean

Include subfolders (default is false)

start
integer

Start record position to retrieve

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/folderapps

Development server

http://localhost:8080/kes/private/v1/folderapps

Response samples

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

Get list of started applications

Returns list of started applications.

Before the request you need to subscribe to the EventSource with name 'startedapps'.

The first request for started applications should be without any query parameters, only after that you can request data for retrive.

Accessible column names:

  • file_name - File;

  • file_hash - File hash code;

  • folder_path - Folder path;

  • certificate_issuer - Issuer;

  • certificate_subject - Subject;

  • certificate_thumbprint - Thumbprint;

  • kl_category_name - Kl category;

  • kl_category_id - Kl category id (Not represintation on UI);

  • original_file_name - File name;

  • file_version - File version;

  • program_name - Application name;

  • program_version - Application version;

  • program_vendor - Vendor;

query Parameters
columns
Array of strings

Columns to retrieve (Array of columns names separated by comma)

end
integer

End record position to retrieve

filter-columns
Array of strings

Columns filtered by (Array of columns names separated by comma)

filter-string
string

Filter string

start
integer

Start record position to retrieve

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/startedapps

Development server

http://localhost:8080/kes/private/v1/startedapps

Response samples

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

Private API (for internal usage only) - Product Info

Get component list

Return component list

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/componentList

Development server

http://localhost:8080/kes/private/v1/componentList

Response samples

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

Private API (for internal usage only) - Product events

Events info

If query isn't specified returns json array of available event names that you can to subscribe, if query is specified you gonna subscribe to events

query Parameters
subscribe
Array of strings

Array of event names separated by commas that you wanna subscribe

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/events

Development server

http://localhost:8080/kes/private/v1/events

Response samples

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

Private API (for internal usage only) - KSN Agreement

Request KSN Agreement accept

Request KSN Agreement accept by user

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/ksn/requestaccept

Development server

http://localhost:8080/kes/private/v1/ksn/requestaccept

Response samples

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

View KSN Agreement

View KSN Agreement in maximized window

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/ksn/vieweula

Development server

http://localhost:8080/kes/private/v1/ksn/vieweula

Response samples

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

Private API (for internal usage only) - Helpers

Get principals info by sid list

Return principal list by sid list

Request Body schema: application/json
sids
Array of strings

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/principalsBySids

Development server

http://localhost:8080/kes/private/v1/principalsBySids

Request samples

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

Response samples

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

Private API (for internal usage only) - Reports

Returns count of rows

Returns count of rows in FileAvReportTable

Request Body schema: application/json
command
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/reports/count

Development server

http://localhost:8080/kes/private/v1/reports/count

Request samples

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

Response samples

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

Returns report records

Returns report records preset with filters in query

Request Body schema: application/json
command
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/reports/view

Development server

http://localhost:8080/kes/private/v1/reports/view

Request samples

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

Response samples

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

Private API (for internal usage only) - General KES settings (by ID)

Gets any product settings

Gets any product settings by id

path Parameters
id
required
integer

ID of desired settings struct in hexadecimal format (begins without 0x)

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/settings/id/{id}

Development server

http://localhost:8080/kes/private/v1/settings/id/{id}

Response samples

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

Sets any product settings

Sets any product settings by id

path Parameters
id
required
integer

ID of desired settings struct in hexadecimal format (begins without 0x)

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/settings/id/{id}

Development server

http://localhost:8080/kes/private/v1/settings/id/{id}

Response samples

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

Gets any product settings

Gets any product settings by id

path Parameters
id
required
integer

ID of desired settings struct in hexadecimal format (begins without 0x)

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v2/settings/id/{id}

Development server

http://localhost:8080/kes/private/v2/settings/id/{id}

Response samples

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

Sets any product settings

Sets any product settings by id

path Parameters
id
required
integer

ID of desired settings struct in hexadecimal format (begins without 0x)

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v2/settings/id/{id}

Development server

http://localhost:8080/kes/private/v2/settings/id/{id}

Response samples

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

Private API (for internal usage only) - Product tasks

Get list of product's task.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/tasks

Development server

http://localhost:8080/kes/private/v1/tasks

Response samples

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

Allows to control task.

NOTE: operation can be performed asynchronously.

path Parameters
task_id
required
string

Task's id (profile name for product)

Request Body schema: application/json
action
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/tasks/{task_id}

Development server

http://localhost:8080/kes/private/v1/tasks/{task_id}

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 task's settings.

Description of the method is not specified

path Parameters
task_id
required
string

Task's id (profile name for product)

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/tasks/{task_id}/settings

Development server

http://localhost:8080/kes/private/v1/tasks/{task_id}/settings

Response samples

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

Apply task's settings.

Description of the method is not specified

path Parameters
task_id
required
string

Task's id (profile name for product)

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/tasks/{task_id}/settings

Development server

http://localhost:8080/kes/private/v1/tasks/{task_id}/settings

Response samples

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

Private API (for internal usage only) - Product trace

Get trace settings.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/private/v1/trace/settings

Development server

http://localhost:8080/kes/private/v1/trace/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "maxRotationFileCount": 0,
  • "maxRotationFileSizeInMb": 0,
  • "traceLevel": 0,
  • "traceState": 0
}

Private API (for internal usage only) - Show window

Show window select principal.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/private/v1/windows/selectprincipal

Development server

http://localhost:8080/kes/private/v1/windows/selectprincipal

Response samples

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

Docs

This documentation

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/api-docs

Development server

http://localhost:8080/kes/public/v1/api-docs

Response samples

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

General KES settings (by name)

Gets a AMSI settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/AMSI

Development server

http://localhost:8080/kes/public/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": 0
}

Sets a AMSI settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
doNotUnpackArchivesWhenBig
boolean
doNotUnpackArchivesWhenBiggerThanMb
integer <int32>
enabled
boolean
scanArchives
boolean
scanInstallPackages
boolean
scanOfficeFiles
boolean
useIChecker
boolean
workMode
integer <uint32>

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/AMSI

Development server

http://localhost:8080/kes/public/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": 0
}

Response samples

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

Gets a AdaptiveAnomaliesControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/AdaptiveAnomaliesControl

Development server

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

Response samples

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

Sets a AdaptiveAnomaliesControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
enabled
boolean
heuristicGroups
Array of objects
messageTemplates
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/AdaptiveAnomaliesControl

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a ApplicationSettings settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/ApplicationSettings

Development server

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

Response samples

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

Sets a ApplicationSettings settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
backgroundScan
object
backupStorage
object
basesValidity
object
debugInformation
object
hsdpStatus
object
notifications
object
operatingMode
object
passwordProtection
object
performance
object
proxy
object
removableDrivesScan
object
reports
object
selfDefense
object
support
object
taskControl
object
userInteraction
object
warnings
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/ApplicationSettings

Development server

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

Request samples

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

Response samples

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

Gets a BehaviourDetection settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/BehaviourDetection

Development server

http://localhost:8080/kes/public/v1/settings/BehaviourDetection

Response samples

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

Sets a BehaviourDetection settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
action
integer <uint32>
enabled
boolean
sfAntiCryptor
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/BehaviourDetection

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a CloudControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/CloudControl

Development server

http://localhost:8080/kes/public/v1/settings/CloudControl

Response samples

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

Sets a CloudControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

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

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/CloudControl

Development server

http://localhost:8080/kes/public/v1/settings/CloudControl

Request samples

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

Response samples

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

Gets a ContextScan settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/ContextScan

Development server

http://localhost:8080/kes/public/v1/settings/ContextScan

Response samples

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

Sets a ContextScan settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
compoundFilesSettings
object
forceAdvancedDisinfection
boolean
heuristicLevel
integer <uint32>
scanAction
integer <uint32>
scanFilter
integer <uint32>
scanUnchangedObjects
boolean
timeLimits
object
useIChecker
boolean
useISwift
boolean

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/ContextScan

Development server

http://localhost:8080/kes/public/v1/settings/ContextScan

Request samples

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

Response samples

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

Gets a DeviceControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/DeviceControl

Development server

http://localhost:8080/kes/public/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":
    {
    }
}

Sets a DeviceControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
allowRequestAccess
boolean
antiBridgingSettings
object
blockMsg
string
busAccessRules
Array of objects
complaintAddress
string
complaintMsg
string
complaintSubject
string
deviceAccessRules
Array of objects
enabled
boolean
fileOperationsMonitoringSettings
object
schedules
Array of objects
trustedDevices
Array of objects
wirelessSettings
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/DeviceControl

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a DiskEncryption settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/DiskEncryption

Development server

http://localhost:8080/kes/public/v1/settings/DiskEncryption

Response samples

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

Sets a DiskEncryption settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
bitlockerFixedDisksSettings
object
fixedDisksEncryptionTechnology
integer <uint32>
kasperskyFdeFixedDisksSettings
object
kasperskyFdeRemovableDisksSettings
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/DiskEncryption

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a EnterpriseApplicationControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/EnterpriseApplicationControl

Development server

http://localhost:8080/kes/public/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":
    [
    ]
}

Sets a EnterpriseApplicationControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
blackListRules
Array of objects
customCategories
Array of objects
defaultDenyMode
boolean
enabled
boolean
id
integer <uint64>
messageTemplates
object
moduleControl
integer <uint32>
testMode
integer <uint32>
whiteListRules
Array of objects

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/EnterpriseApplicationControl

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a ExclusionsSettings settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/ExclusionsSettings

Development server

http://localhost:8080/kes/public/v1/settings/ExclusionsSettings

Response samples

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

Sets a ExclusionsSettings settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
scanExclusionsAndTrustedZone
object
threats
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/ExclusionsSettings

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a ExploitPrevention settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/ExploitPrevention

Development server

http://localhost:8080/kes/public/v1/settings/ExploitPrevention

Response samples

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

Sets a ExploitPrevention settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
action
integer <uint32>
enableSystemProcessesMemoryProtection
boolean
enabled
boolean

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/ExploitPrevention

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a FileAv settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/FileAv

Development server

http://localhost:8080/kes/public/v1/settings/FileAv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "compoundFilesSettings":
    {
    },
  • "enabled": true,
  • "heuristicLevel": 0,
  • "scanAction": 0,
  • "scanFilter": 0,
  • "scanMode": 0,
  • "scanScope":
    [
    ],
  • "scanUnchangedObjects": true,
  • "sleepMode":
    {
    },
  • "useIChecker": true,
  • "useISwift": true
}

Sets a FileAv settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
compoundFilesSettings
object
enabled
boolean
heuristicLevel
integer <uint32>
scanAction
integer <uint32>
scanFilter
integer <uint32>
scanMode
integer <uint32>
scanScope
Array of objects
scanUnchangedObjects
boolean
sleepMode
object
useIChecker
boolean
useISwift
boolean

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/FileAv

Development server

http://localhost:8080/kes/public/v1/settings/FileAv

Request samples

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

Gets a FileEncryption settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/FileEncryption

Development server

http://localhost:8080/kes/public/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":
    {
    }
}

Sets a FileEncryption settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
adminMessageTemplate
string
complaintBodyTemplate
string
complaintRecipient
string
complaintSubject
string
fixedDriveSettings
object
removableDriveSettings
object
secureWipeOriginals
boolean
sfxPasswordSettings
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/FileEncryption

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a Hips settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/Hips

Development server

http://localhost:8080/kes/public/v1/settings/Hips

Response samples

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

Sets a Hips settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
firewall
object
hips
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/Hips

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a KATA settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/KATA

Development server

http://localhost:8080/kes/public/v1/settings/KATA

Response samples

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

Sets a KATA settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
ServerAddress
string
ServerPort
integer <uint16>
enabled
boolean

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/KATA

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a KeyboardAuthorization settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/KeyboardAuthorization

Development server

http://localhost:8080/kes/public/v1/settings/KeyboardAuthorization

Response samples

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

Sets a KeyboardAuthorization settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
enableVirtualKeyboard
boolean
enabled
boolean

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/KeyboardAuthorization

Development server

http://localhost:8080/kes/public/v1/settings/KeyboardAuthorization

Request samples

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

Response samples

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

Gets a Ksn settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/Ksn

Development server

http://localhost:8080/kes/public/v1/settings/Ksn

Response samples

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

Sets a Ksn settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
agreedKsnMd5s
Array of strings
enableCloudAVMode
boolean
ksnInaccessibleCloudAvModeSeverity
integer <uint32>
ksnInaccessibleSeverity
integer <uint32>
requestsAgreement
object
statisticsAgreement
object
useKlServers
boolean
useKsnProxy
boolean

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/Ksn

Development server

http://localhost:8080/kes/public/v1/settings/Ksn

Request samples

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

Response samples

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

Gets a MailAv settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/MailAv

Development server

http://localhost:8080/kes/public/v1/settings/MailAv

Response samples

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

Sets a MailAv settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
attachmentsFilterSettings
object
compoundFilesSettings
object
enabled
boolean
heuristicLevel
integer <uint32>
outlookPluginSettings
object
scanAction
integer <uint32>
scanDirection
integer <uint32>
scanMailTraffic
boolean

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/MailAv

Development server

http://localhost:8080/kes/public/v1/settings/MailAv

Request samples

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

Response samples

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

Gets a NetworkThreatProtection settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/NetworkThreatProtection

Development server

http://localhost:8080/kes/public/v1/settings/NetworkThreatProtection

Response samples

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

Sets a NetworkThreatProtection settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
banTimeout
integer <uint32>
enableBan
boolean
enabled
boolean
excludeIPs
Array of objects
macSpoofingProtectionMode
integer <uint32>

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/NetworkThreatProtection

Development server

http://localhost:8080/kes/public/v1/settings/NetworkThreatProtection

Request samples

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

Response samples

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

Gets a RemediationEngine settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/RemediationEngine

Development server

http://localhost:8080/kes/public/v1/settings/RemediationEngine

Response samples

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

Sets a RemediationEngine settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
enabled
boolean

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/RemediationEngine

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a TrafficMonitorSettings settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/TrafficMonitorSettings

Development server

http://localhost:8080/kes/public/v1/settings/TrafficMonitorSettings

Response samples

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

Sets a TrafficMonitorSettings settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
portsMonitoring
object
trafficDecoding
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/TrafficMonitorSettings

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Gets a WebAv settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/WebAv

Development server

http://localhost:8080/kes/public/v1/settings/WebAv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "antiphishingSettings":
    {
    },
  • "checkLinksWithSuspiciousUrlDatabase": true,
  • "enabled": true,
  • "heuristicLevel": 0,
  • "scanAction": 0,
  • "trustedUrlSettings":
    {
    }
}

Sets a WebAv settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
antiphishingSettings
object
checkLinksWithSuspiciousUrlDatabase
boolean
enabled
boolean
heuristicLevel
integer <uint32>
scanAction
integer <uint32>
trustedUrlSettings
object

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/WebAv

Development server

http://localhost:8080/kes/public/v1/settings/WebAv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "antiphishingSettings":
    {
    },
  • "checkLinksWithSuspiciousUrlDatabase": true,
  • "enabled": true,
  • "heuristicLevel": 0,
  • "scanAction": 0,
  • "trustedUrlSettings":
    {
    }
}

Response samples

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

Gets a WebControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/settings/WebControl

Development server

http://localhost:8080/kes/public/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"
}

Sets a WebControl settings

Description of the method is not specified

header Parameters
Big-Int-String-Format
string

If the param is specified than int64 numbers in response will have a string representation

Request Body schema: application/json
advancedSettings
object
complaintBodyTemplate
string
complaintRecipient
string
complaintSubject
string
defaultVerdict
integer <uint32>
denyMessageTemplate
string
enabled
boolean
rules
Array of objects
schedules
Array of objects
urlCategories
Array of objects
warnMessageTemplate
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/settings/WebControl

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Product tasks

Get list of product's task.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/tasks

Development server

http://localhost:8080/kes/public/v1/tasks

Response samples

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

Allows to control task.

NOTE: operation can be performed asynchronously.

Request Body schema: application/json
action
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/IntegrityCheck

Development server

http://localhost:8080/kes/public/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 IntegrityCheck settings.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/tasks/IntegrityCheck/settings

Development server

http://localhost:8080/kes/public/v1/tasks/IntegrityCheck/settings

Response samples

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

Set IntegrityCheck settings.

Description of the method is not specified

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

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/IntegrityCheck/settings

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Allows to control task.

NOTE: operation can be performed asynchronously.

Request Body schema: application/json
action
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Rollback

Development server

http://localhost:8080/kes/public/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 settings.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/tasks/Rollback/settings

Development server

http://localhost:8080/kes/public/v1/tasks/Rollback/settings

Response samples

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

Set Rollback settings.

Description of the method is not specified

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

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Rollback/settings

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Allows to control task.

NOTE: operation can be performed asynchronously.

Request Body schema: application/json
action
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Scan_My_Computer

Development server

http://localhost:8080/kes/public/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 Scan_My_Computer settings.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/tasks/Scan_My_Computer/settings

Development server

http://localhost:8080/kes/public/v1/tasks/Scan_My_Computer/settings

Response samples

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

Set Scan_My_Computer settings.

Description of the method is not specified

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

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Scan_My_Computer/settings

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Allows to control task.

NOTE: operation can be performed asynchronously.

Request Body schema: application/json
action
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Scan_Objects

Development server

http://localhost:8080/kes/public/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 Scan_Objects settings.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/tasks/Scan_Objects/settings

Development server

http://localhost:8080/kes/public/v1/tasks/Scan_Objects/settings

Response samples

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

Set Scan_Objects settings.

Description of the method is not specified

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

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Scan_Objects/settings

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Allows to control task.

NOTE: operation can be performed asynchronously.

Request Body schema: application/json
action
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Scan_Startup

Development server

http://localhost:8080/kes/public/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 Scan_Startup settings.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/tasks/Scan_Startup/settings

Development server

http://localhost:8080/kes/public/v1/tasks/Scan_Startup/settings

Response samples

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

Set Scan_Startup settings.

Description of the method is not specified

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

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Scan_Startup/settings

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}

Allows to control task.

NOTE: operation can be performed asynchronously.

Request Body schema: application/json
action
string

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Updater

Development server

http://localhost:8080/kes/public/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 settings.

Description of the method is not specified

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

get /kes/public/v1/tasks/Updater/settings

Development server

http://localhost:8080/kes/public/v1/tasks/Updater/settings

Response samples

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

Set Updater settings.

Description of the method is not specified

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

Responses

200

OK

403

You don't have permission to access

500

Unexpected error

post /kes/public/v1/tasks/Updater/settings

Development server

http://localhost:8080/kes/public/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
{
  • "code": 0,
  • "description": "string"
}