Перейти к содержанию

Модель

Модель данных Vulnerability

Параметр Тип данных Обязательность Описание
id string Required Идентификатор уязвимости
created_at string Required Дата создания в формате: date-time
updated_at string Required Дата изменения в формате: date-time
trace_id string Required Идентификатор трассировки действия пользователя для аудита
plugin_id integer Optional Идентификатор плагина (сканера уязвимостей)
plugin_name string Optional Название плагина
description string Optional Описание уязвимости
severity integer Optional Важность
additional_data Array<object> Optional Дополнительные данные в формате map<string,string>
protocol string Optional Тип протокола (tcp, udp и пр.). “-1”, если не определён
port integer Optional Порт
occurrence_id string Optional Идентификатор происшествия в формате uuid
synopsis string Optional Краткое описание
vulnerability_host_id string Optional Идентификатор хоста уязвимости
exploitable boolean/null Optional Флаг, указывающий на возможность использования уязвимости мошенниками
plugin_output string Optional Результат работы плагина, зависит от типа отчета (сканирования)
solution string Optional Алгоритм устранения уязвимости
compare_port integer Optional Результат сравнения портов. При создании из результата сканирования, совпадает с полем port
compare_protocol string Optional Результат сравнения протоколов. При создании из результата сканирования, совпадает с полем protocol
service_asset_id string Optional Идентификатор актива
vulnerability_scan_id string Optional Идентификатор результата сканирования (отчёта)
external boolean Optional Флаг, является ли уязвимость внешней
remote_exploitable boolean Optional Флаг, можно ли использовать уязвимость удалённо
cvss_vector string Optional Вектор метрик оценки по CVSS
cvss_temporal_vector string Optional Вектор временных метрик оценки по CVSS
cvss_base_score number Optional Оценка уязвимости по CVSS
cvss_temporal_score number Optional Временная оценка уязвимости по CVSS
risk_factor string Optional Уровень риска в текстовом формате (none, low, medium и т.д.)
plugin_modification_date string Optional Дата изменения плагина (не связано с изменениями в БД, заполняется из результата сканирования) в формате: date-time
publication_date string Optional Дата публикации в формате: date-time
PluginSum string Optional - Для nmap: хэш-сумма (sha256) поля plugin_output
- Для остальных отчетов не задаётся
service_asset_finding_id string Optional Идентификатор инцидента
service_asset_finding_status string Optional Статус инцидента
removed_vulnerability null/boolean Optional Находится ли уязвимость на удалении. Отвечает за наличие вкладки to_close
changed_vulnerability null/boolean Optional Находится ли уязвимость в работе. Отвечает за наличие вкладки processed
added_vulnerability null/boolean Optional Добавлена ли уязвимость и над ней еще не выполнялась работа. Отвечает за наличие вкладки to_add
ip string Optional IP-адрес хоста
finding_ids Array<string> Optional Идентификаторы типов инцидентов
os string Optional Операционная система
fqdn string Optional Список FQDN хостов в формате postgresql-массива
authenticated boolean Optional Флаг аутентификации
plugin_is_blacklisted boolean Optional Флаг, находится ли связанный плагин в черном списке или нет
with_findings boolean Optional
plugin_id_text string Optional Идентификатор плагина в текстовом формате для поиска по строке
occurrence object<Occurrence> Optional Связанное происшествие
vulnerability_host object<VulnerabilityHost> Optional Хост уязвимости
service_asset object<Service_asset> Optional Связанный актив
vulnerability_scan object Optional Связанный результат сканирования

Модель данных Occurrence

Параметр Тип данных Обязательность Описание
id string Required Идентификатор происшествия
created_at string time Required Дата создания происшествия в формате: date-time
updated_at string time Required Дата изменения происшествия в формате: date-time
trace_id string Required Идентификатор трассировки действия пользователя для аудита
event_type string Required Тип происшествия. Допустимые значения:
- manual_source
- logmule_go_result
- software_compliance_source
- vulnerability
- watchdog_result
ip string Required IP-адрес актива
mac string Required MAC-адрес актива
port integer Порт актива
start_occurrence string Required Время первого изменения статуса в клиентской системе
end_occurrence string Required Время последнего изменения статуса в клиентской системе
service_asset_finding_status_change_id string Required Идентификатор смены статуса инцидента
service_asset_finding_id string Required Идентификатор инцидента
fqdn string Required FQDN актива
incident_identifier string Required Идентификатор инцидента во внешней системе
fincert_sync_status number Required Состояние синхронизации с внешней системой
fincert_id string Required Идентификатор внешней системы
sopka_sync_status number Required Состояние синхронизации с ГосСОПКА
sopka_id string Required Идентификатор ГосСОПКА
fincert_sync_result string Required Результат синхронизации с внешней системой
sopka_sync_result string Required Результат синхронизации с ГосСОПКА

Модель данных VulnerabilityHost

Параметр Тип данных Обязательность Описание
id string Required Идентификатор
created_at string Required Дата создания в формате date-time
updated_at string Required Дата изменения в формате date-time
ip string Optional IP-адрес в формате ipv4
mac string Optional MAC-адрес
fqdn string Optional Доменное имя
properties string Optional Дополнительные свойства (не используется)
scan_begin null / string Optional Начало сканирования в формате date-time
scan_end null / string Optional Окончание сканирования в формате date-time
service_asset_id string Optional Идентификатор актива
vulnerability_scan_id string Optional Идентификатор результата сканирования
os string Optional Операционная система
authenticated boolean Optional Флаг аутентификации
scan_error string Optional Ошибка при сканировании
name string Required Название хоста
authentication_info object Optional Информация для аутентификации (не используется)
Словарь (ключ-значение)
- ключ: string
- значение: любой тип
vulns_count integer Optional Суммарное число уязвимостей на хосте
v0_count integer Optional Число уязвимостей с важностью 0
v1_count integer Optional Число уязвимостей с важностью 1
v2_count integer Optional Число уязвимостей с важностью 2
v3_count integer Optional Число уязвимостей с важностью 3
v4_count integer Optional Число уязвимостей с важностью 4
installed_software_count integer Optional Число установленного на хосте ПО

Модель данных ServiceAsset

Параметр Тип данных Обязательность Описание
id string Required Идентификатор актива
created_at string Required Дата создания актива в формате date-time
updated_at string Required Дата изменения актива в формате date-time
trace_id string Required Идентификатор трассировки действия пользователя для аудита
type string Required Тип актива
name string Required Название актива
description string Optional Описание актива
coordinates string Optional Координаты актива
active boolean Optional Флаг активности
scan_id string Optional Идентификатор сканера
value integer Optional Значимость актива
client_note string Optional Клиентские заметки
internal_note string Optional Внутренние заметки
location string Optional Расположение актива
network_exposure integer Optional Сетевая доступность актива. Тип сетевой видимости актива может принимать следующие значения:
- 1 – актив напрямую подключен к сети Интернет;
- 2 – актив располагается в демилитаризованной зоне (DMZ);
- 3 – актив подключен к сети Интернет через Proxy-сервер;
- 4 – актив имеет ограниченный доступ к сети Интернет и к ограниченному набору онлайн-сервисов. Например, тонкие клиенты, POS-терминалы, удаленные офисы;
- 5 – актив не подключен к сети.
responsible_person string Optional Ответственное лицо
technical_specialist string Optional Технический специалист
responsible_group_id string Optional Идентификатор группы ответственных
edited_by string Optional Кем изменён

Модель данных ServiceAssets

Примечание: используется в ответе при выполнении запроса поиска о результатах сканирования для сравнения.

Параметр Тип данных Обязательность Описание
id string Required Идентификатор актива
created_at string Required Дата создания в формате date-time
updated_at string Required Дата изменения в формате date-time
trace_id string Required Идентификатор трассировки действия пользователя для аудита
type string Required Тип актива
name string Required Название актива
description string Optional Описание актива
coordinates string Optional Координаты актива
active boolean Optional Флаг активности
scan_id string Optional Идентификатор сканера
value integer Optional Значимость актива
client_note string Optional Клиентские заметки
internal_note string Optional Внутренние заметки
location string Optional Расположение актива
network_exposure integer Optional Сетевая доступность актива. Тип сетевой видимости актива может принимать следующие значения:
- 1 – актив напрямую подключен к сети Интернет;
- 2 – актив располагается в демилитаризованной зоне (DMZ);
- 3 – актив подключен к сети Интернет через Proxy-сервер;
- 4 – актив имеет ограниченный доступ к сети Интернет и к ограниченному набору онлайн-сервисов. Например, тонкие клиенты, POS-терминалы, удаленные офисы;
- 5 – актив не подключен к сети.
responsible_person string Optional Ответственное лицо
technical_specialist string Optional Технический специалист
responsible_group_id string Optional ID группы ответственных
edited_by string Optional Кем изменён
severity_0 integer Optional Счетчик всех уязвимостей на активе с важностью 0
severity_1 integer Optional Счетчик всех уязвимостей на активе с важностью 1
severity_2 integer Optional Счетчик всех уязвимостей на активе с важностью 2
severity_3 integer Optional Счетчик всех уязвимостей на активе с важностью 3
severity_4 integer Optional Счетчик всех уязвимостей на активе с важностью 4
scanned_host_data Array<ScannedHostData> Optional Массив vulnerability_host
known_host_data Array<KnownHostData> Optional Массив network_interface

Модель ScannedHostData

Параметр Тип данных Обязательность Описание
id string Required Идентификатор хоста
created_at string Required Дата создания в формате date-time
updated_at string Required Дата изменения в формате date-time
trace_id string Required Идентификатор трассировки действия пользователя для аудита
ip string Optional IP-адрес
mac string Optional MAC-адрес
fqdn string Optional FQDN
properties string Optional Свойства
scan_begin null/string Optional Начало сканирования
scan_end null/string Optional Конец сканирования
service_asset_id string Optional Идентификатор актива
vulnerability_scan_id string Optional Идентификатор сканера уязвимостей
os string Optional Наименование операционной системы
authenticated boolean Optional Включена ли проверка аутентификации
scan_error string Optional Ошибки сканирования
name string Optional Наименование сканера
authentication_info object Optional Словарь (ключ-значение)

Модель KnownHostData

Параметр Тип данных Обязательность Описание
id string Required Идентификатор сетевого интерфйеса
created_at string Required Дата создания в формате date-time
updated_at string Required Дата изменения в формате date-time
trace_id string Required Идентификатор трассировки действия пользователя для аудита
name string Required Название сетевого интерфейса
ip string Optional IP адрес сетевого интерфейса
mac string Optional MAC адрес сетевого интефейса
os string Optional Операционная система
service_asset_id string Optional Идентификатор связанного актива
edited_by string Optional Идентификатор пользователя внесшего изменения
service_asset_name string Optional Название связанного актива
service_asset_location string Optional Локация связанного актива
service_asset_value integer Optional Значение связанного актива
service_asset_network_exposure integer Optional Cетевая видимость связанного актива
service_asset_group_names Array<string> Optional Список названий связанных групп активов