Request for getting the list of hosts with the Endpoint Agent component

To create a request for information about hosts with the Endpoint Agent component, the GET HTTP method is used.

Command syntax

GET "<URL of the Central Node server>:<port, 443 by default>/kata/response_api/v1/<external_system_id>/sensors"

If the request is processed successfully, a list of hosts with the Endpoint Agent component is displayed.

You can create a request for information about hosts with filters by IP address, name, or ID of the host. You can specify one, multiple, or all of these filters.

When specifying a host name, you need to keep in mind that the filter is case-sensitive.

GET "<URL of the Central Node server>:<port, 443 by default>/kata/response_api/v1/<external_system_id>/sensors?ip=<IP address of the host>&host=<host name>&sensor_id=<sensor_id>"

If the request is processed successfully, information about the selected host with the Endpoint Agent component is displayed.

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
ip	string	IP address of the host with the Endpoint Agent component.
host	string	Name of the host with the Endpoint Agent component.

Example of entering commands with parameters

GET "https://10.10.0.22:443/kata/response_api/v1/15301050-0490-4A41-81EA-B0391CF21EF3/sensors"

GET "https://10.10.0.22:443/kata/response_api/v1/15301050-0490-4A41-81EA-B0391CF21EF3/sensors?ip=10.16.40.243&host=host4&sensor_id=DF64838B-B518-414B-B769-2B8BE341A2F0"

Response

HTTP code: 200

Format: JSON

type Response Sensors

type Server struct {

Version string `json:"version"`

},

type Sensors struct {

SensorID UUID `json:"sensorId"`

HostIP string `json:"hostIp"`

LastAccessTimestamp `json:"lastAccessTimestamp"`

Version string `json:"version"`

SelfDefenseState boolean `json:"selfDefenseState"`

LicenseStatus string `json:"licenseStatus"`

OSFamily string `json:"osFamily"`

OSName string `json:"osName"`

Capabilities array `json:"capabilities"`

}

Returned value

Return code	Description
400	Authorization required.
401	Incorrect parameters.
500, 502, 503, 504	Internal server error. Repeat the request later.

Page top