Request for information about network isolation and the existence of prevention rules for hosts with the Kaspersky Endpoint Agent component

HTTP method GET is used to create a request to display information about network isolation and the existence of prevention rules for hosts with the Endpoint Agent component.

Command syntax

GET "<URL of the Central Node server>:<port, 443 by default>/kata/response_api/v1/<external_system_id>/settings?sensor_id=<sensor_id>&settings_type=<network_isolation or prevention>"

If the request is processed successfully, the list of hosts with the Endpoint Agent component is displayed, listing hosts that had prevention rules or network isolation rules applied at the moment when the request was processed.

Settings

Parameter	Type	Description
external_system_id	UUID	Unique ID of the external system used for authorization in Kaspersky Anti Targeted Attack Platform.
sensor_id	UUID	Unique ID of the host with the Endpoint Agent component
settings_type	enum	Rule type: network_isolation or prevention.

Example of entering a command with switches

GET "https://10.10.0.22:443/kata/response_api/v1/15301050-0490-4A41-81EA-B0391CF21EF3/settings?sensor_id=DF64838B-B518-414B-B769-2B8BE341A2F0&settings_type=network_isolation"

Response

HTTP code: 200

Format: JSON

type Response []Settings   type Settings struct { ExcludedRules array `json:"excludedRules"` AutoTurnoffTimeoutInSec int `json:"autoTurnoffTimeoutInSec"` }

Returned value

Return code	Description
400	Authorization required.
401	Incorrect parameters.
404	Specified hosts with the Endpoint Agent component not found.
500, 502, 503, 504	Internal error. Repeat the request later.

Page top