Request for getting the list of hosts with the Endpoint Agent component
8 November 2023
ID 227251
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 |
|---|---|---|
| UUID | Unique ID of the external system used for authorization in Kaspersky Anti Targeted Attack Platform. |
| UUID | Unique ID of the host with the Endpoint Agent component |
| string | IP address of the host with the Endpoint Agent component. |
| string | Name of the host with the Endpoint Agent component. |
Example of entering commands with parameters
|
|
Returned value
Return code | Description |
|---|---|
| Operation completed successfully. |
| Authorization required. |
| Incorrect parameters. |
| Internal server error. Repeat the request later. |
