Обзор
Основные характеристики
| Характеристика | Значение |
|---|---|
| Наименование | sonar |
| Компоненты | Cruddy |
| Появился в версии | 4.1.0 |
| Доступен в версиях | 4.1.0 и выше |
| Авторизация по токену | Security scheme type: httpBearer format: JWT |
| Авторизация по APIkey | Security scheme type: apiKeyHeader parameter name: PgrApiKey |
| Версия API | v2 |
Описание: Ресурс sonar отвечает за сканирование и сбор информации с активов.
Список методов для работы с ресурсом
KSC-log
Конечная точка для работы с журналами работы интеграции Kaspersky SecurityCcenter (KSC).
| Тип | Метод | Описание |
|---|---|---|
GET |
/sonar/ksc-log/{uid} | Получение KSC-лога |
Devices
Конечная точка для работы с хостами.
| Тип | Метод | Описание |
|---|---|---|
POST |
/sonar/devices/scan | Запуск сканирования подсети и получения массива хостов |
POST |
/sonar/devices/update | Создание сетевых интерфейсов из хостов, полученных в результате сканирования, . Если в базе уже есть интерфейс с переданным ipv4, то будет выполнено обновление информации о нем. |
POST |
/sonar/devices/scan-update | Запуск сканирования подсети и автоматическое создание интерфейсов, из хостов, полученных в результате сканирования |
Services
Конечная точка для работы с сервисами, обнаруженными на хостах
| Тип | Метод | Описание |
|---|---|---|
POST |
/sonar/services/scan | Запуск сканирования хостов и получение массива сервисов, обнаруженных на хостах |
POST |
/sonar/services/update | Создание/обновление информации о сервисах, обнаруженных на хостах |
Hardware
Конечная точка для работы с аппаратным обеспечением, обнаруженном на хостах.
| Тип | Метод | Описание |
|---|---|---|
POST |
/sonar/hardware/scan | Запуск сканирования хостов и получение информации об аппаратном обеспечении, обнаруженном на хосте |
POST |
/sonar/hardware/gather | Создание/обновление информации об аппаратном обеспечении хостов |
POST |
/sonar/hardware/mass-gather | Запуск сканирования и автоматическое создание/обновление информации об аппаратном обеспечении |
Software
Конечная точка для работы с программным обеспечением, обнаруженном на хостах.
| Тип | Метод | Описание |
|---|---|---|
POST |
/sonar/software/scan | Запуск сканирования хостов и получение информации о программном обеспечении, обнаруженном на хосте |
POST |
/sonar/software/gather | Создание/обновление информации о программном обеспечении хостов |
POST |
/sonar/software/mass-gather | Запуск сканирования и автоматическое создание/обновление информации о программном обеспечении |
Ответы методов
| Статус код | Описание |
|---|---|
200 |
Успех |
201 |
Успешное создание объекта |
204 |
Успешный ответ. Пустое тело ответа |
400 |
Неверный тип параметра запроса, либо отсутствует обязательный параметр |
404 |
Ресурс не найден |
409 |
Попытка присвоить объекту существующее уникальное значение атрибута |
422 |
Внутренняя ошибка удаления |
500 |
Ошибка сервера |
Модели объектов
| Название | Описание |
|---|---|
| sonar_model | Модель данных ресурса sonar |