Получение информации аудита

Kaspersky Research Sandbox предоставляет API для получения информации аудита.

В случае полного аудита безопасности все события аудита можно загрузить через API.

Эта функция доступна только для пользователей Kaspersky Research Sandbox с правами администратора (Role=Admin).

Запрос

Метод запроса: GET

Конечная точка: https://<server name>/api/v1/audit?<parameters>

Параметры

Параметры получения информации аудита

Параметр

Тип данных

Вхождение

Описание

from

строка <дата-время>

Необязательно

Будет получена информация о действиях пользователя начиная с даты и времени, указанных в соответствии со стандартами RFC 3339. Например, 2018-10-20T15:04:05Z или 2018-10-30T15:04:05%2B03:00, с указанным часовым поясом (здесь %2B – символ + в процентной кодировке).

Если данный параметр не указан, будет получена информация обо всех действиях пользователя, которые происходили с момента установки Kaspersky Research Sandbox.

to

строка <дата-время>

Необязательно

Будет получена информация о действиях пользователя заканчивая датой и временем, указанными в соответствии со стандартами RFC 3339. Например, 2018-10-20T15:04:05Z или 2018-10-30T15:04:05%2B03:00, с указанным часовым поясом (здесь %2B – символ + в процентной кодировке).

Если данный параметр не указан, будет получена информация обо всех действиях пользователя, которые произошли до момента выполнения метода audit.

action

строка

Необязательно

Действия пользователя, по которым вы хотите получить информацию аудита.

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

Доступные значения:

  • login – пользователь попытался войти в Kaspersky Research Sandbox.
  • logout – пользователь вышел из Kaspersky Research Sandbox или время сеанса истекло.
  • eula_agree – пользователь принял Лицензионное соглашение.
  • account_add – пользователь создал новую учетную запись Kaspersky Research Sandbox.
  • account_del – пользователь удалил учетную запись Kaspersky Research Sandbox.
  • account_edit – пользователь изменил настройки учетной записи Kaspersky Research Sandbox.
  • account_pwd_change – пользователь изменил пароль учетной записи.
  • create_task – пользователь создал задачу выполнения образца.
  • rescan_task – пользователь повторно проверил образец.
  • export_task_results – пользователь экспортировал результаты выполнения образца (с помощью веб-интерфейса и RESTful API).
  • export_task_section – пользователь экспортировал результаты определенного раздела (с помощью веб-интерфейса и RESTful API).
  • download_task_results – пользователь скачал результаты выполнения файла из веб-интерфейса Kaspersky Research Sandbox.
  • create_image – пользователь создал образ.
  • import_image – пользователь импортировал образ.
  • export_image – пользователь экспортировал образ.
  • update_image – пользователь обновил образ.
  • delete_image – пользователь удалил образ.
  • activate_image – пользователь активировал образ.
  • export_image_manifest – пользователь экспортировал манифест образа.
  • deploy_snapshot – пользователь развернул среду выполнения.
  • delete_snapshot – пользователь удалил среду выполнения.
  • update_snapshot – пользователь обновил среду выполнения.
  • upload_storage_media – пользователь загрузил ISO-образ диска.
  • update_storage_media – пользователь обновил ISO-образ диска.
  • delete_storage_media – пользователь удалил ISO-образ диска.

limit

целое число

Необязательно

Количество записей для получения.

Доступные значения: 0–10000.

Значение по умолчанию: 10000.

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

ascending

логический

Необязательно

Сортирует записи в порядке возрастания или убывания:

  • true – сортирует записи в порядке возрастания.
  • false – сортирует записи в порядке убывания.

Пример команды cURL:

$ curl -u <user name> --request GET https://<server name>/api/v1/audit?from=2018-10-30T15:04:05%2B03:00

Вам будет предложено ввести пароль. Пароль не отображается во время ввода.

Ответы

Конечная точка возвращает объект JSON, содержащий информацию аудита о действиях пользователя. Объекты сортируются по значению Ts в порядке убывания.

200 OK

Информация аудита получена успешно.

Параметры ответа 200 OK

Параметр

Тип данных

Описание

Id

строка

Идентификатор записи аудита.

Ts

строка <дата-время>

Дата и время сохранения информации аудита в соответствии со стандартом RFC 3339.

Action

строка

Тип действия пользователя (например, login).

Username

строка

Имя пользователя учетной записи Kaspersky Research Sandbox, для которой получена информация аудита.

Data

массив объектов

Конкретные данные по каждому типу (действию) записи аудита.

Пример ответа 200 OK:

[

{

"Id": "string",

"Ts": "2018-10-20T15:04:05Z",

"Action": "string",

"Username": "string",

"Data": {

"AuthResult": "success",

"Login": "string",

"PassHash": "*"

}

]

400 Bad Request

Не удалось получить информацию аудита из-за неверного запроса.

Параметры ответа 400 Bad Request

Параметр

Тип данных

Описание

code

строка

Идентификатор ошибки.

message

строка

Описание ошибки.

meta

строка

Дополнительная информация, если таковая имеется.

Примеры ошибок:

Неверный параметр username:

{"code":42,"message":"invalid value","meta":"username"}

Неверный параметр limit:

{"code":42,"message":"invalid value","meta":"limit"}

401 Unauthorized

Не удалось получить информацию аудита из-за неверных учетных данных пользователя.

500 Internal Server Error

Не удалось получить информацию аудита из-за внутренней ошибки сервера.

В начало