Запрос на вывод информации об обнаружениях

Для создания запроса на вывод информации об обнаружениях Kaspersky Anti Targeted Attack Platform используется HTTP-метод GET. Создать запрос можно, например, с помощью утилиты командной строки cURL.

Синтаксис команды

curl --cert <путь к файлу TLS-сертификата> --key <путь к файлу закрытого ключа> -X GET "<URL-адрес сервера с компонентом Central Node>:<порт, по умолчанию 443>/kata/scanner/v1/sensors/<идентификатор sensorId>/detects?detect_type=<одна или несколько технологий, с помощью которых выполнено обнаружение>&limit=<количество обнаружений в ответе на запрос>&token=<идентификатор запроса>"

При успешной обработке запроса отобразится список обнаружений, выполненных приложением Kaspersky Anti Targeted Attack Platform на сервере внешней системы.

Параметры

Параметр

Тип

Описание

sensorId

String

Уникальный идентификатор внешней системы, используемый для авторизации в Kaspersky Anti Targeted Attack Platform.

detect_type

Array

Технология, с помощью которой выполнено обнаружение. Возможно указать несколько технологий через запятую.

Возможные значения:

  • am – Anti-Malware Engine;
  • sb – Sandbox;
  • yara – YARA;
  • url_reputation – URL Reputation;
  • ids – Intrusion Detection System.

Если параметр не указан, предоставляется информация обо всех обнаружениях.

limit

Integer

Количество объектов, информация о которых будет предоставлена в ответ на запрос. Допустимые значения: целые числа от 1 до 10000.

По умолчанию установлено значение 1000.

token

String

Идентификатор запроса. При указании этого параметра в повторном запросе не отображается информация об обнаружениях, полученная в предыдущих запросах. Это позволяет избежать дублирования информации об одних и тех же обнаружениях при повторных запросах.

Если этот параметр не указан, предоставляется информация обо всех обнаружениях.

Ответ

HTTP-код: 200

Формат: JSON

type Response struct {

   Detects array  `json:"detects"`

   Token   string `json:"token"`

}

Возвращаемое значение

Код возврата

Описание

400

Ошибка ввода параметров.

429

Превышено количество запросов.

401

Требуется авторизация.

500

Внутренняя ошибка сервера. Повторите запрос позднее.

Пример ввода команды с параметрами

curl --cert /root/cert.pem --key /root/server.key -X GET "https://10.10.10.1:443/kata/scanner/v1/sensors/dd11a1ee-a00b-111c-b11a-11001b1f1111/detects?detect_type=am,sb&limit=100&token=7b226f6666736574223a20307d"

В начало