Модель
ScanDeviceResult
Результаты сканирования хостов:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| host | Array<string> |
Required | Список хостов, полученных в результате сканирования |
| ipv4 | string |
Required | IP-адрес хоста в формате ipv4 |
| mac | string |
Required | MAC-адрес хоста |
| ipv6 | string |
Required | IP-адрес хоста в формате ipv6 |
ServicesScanResult
Результаты сканирования сервисов:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| ipv4 | string |
Required | IP-адрес хоста в формате ipv4 |
| ipv6 | string |
Required | IP-адрес хоста в формате ipv6 |
| mac | string |
Required | MAC-адрес хоста |
| os | string |
Required | Операционная система |
| services | Array<services> |
Required | Сервисы |
| error_code | integer |
Required | Код ошибки. Возможные значения: - 0 — нет ошибки, - 13001 — недопустимый формат IP-адреса |
| error | string |
Required | Текст ошибки |
Services
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор сервиса в формате uuid |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| network_interface_id | string |
Required | Идентификатор связанного сетевого интерфейса в формате uuid |
| port | string |
Required | Порт, на котором работает сервис |
| status | string |
Required | Статус сервиса |
| type | string |
Required | Тип сервиса |
| name | string |
Required | Название сервиса |
| version | string |
Required | Версия |
| cpe | string |
Required | Common Platform Enumeration (CPE) идентификатор (CPE-идентификатор) |
AssetServiceScanResult
Результаты сканирования актива:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| assetId | string |
Required | Идентификатор актива в формате uuid |
| nicServices | Array<object> |
Required | Массив сервисов сетевого интерфейса |
| nicServices{networkInterfaceId} | string |
Required | Идентификатор сетевого интерфейса uuid |
| nicServices{os} | string |
Required | Операционная система |
| nicServices{services} | Array<services> |
Required | Сервисы |
| nicServices{error_code} | integer |
Required | Код ошибки. Возможные значения: - 0 — нет ошибки, - 12012 — недопустимый формат ID - 11004 — актив не найден - 13002 — не найдены сетевые интерфейсы актива - 1497 — прочие ошибки чтения актива |
| nicServices{erro} | string |
Required | Текст ошибки |
InventoryDTO
Сбор данных с активов:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| ip | string |
Required | IP-адрес актива ipv4 |
| credentialId | Array<object> |
Required | Идентификатор учетной записи для сбора данных |
| type | string |
Required | Тип подключения: - ssh - rpc - wmi |
EnrichmentInfo
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| ip | string |
Required | IP-адрес актива ipv4 |
| credentialId | Array<object> |
Required | Идентификатор учетной записи для сбора данных |
| type | string |
Required | Тип подключения: - ssh - rpc - wmi |
HardwareInformation
Информация об аппаратном обеспечении
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор аппаратного обеспечения в формате uuid |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| service_asset_id | string |
Required | Идентификатор актива |
| hardware_type | string |
Required | Тип устройства |
| name | string |
Required | Название аппаратного обеспечения |
| manufacturer | string |
Required | Производитель аппаратного обеспечения |
| serial_number | string |
Required | Серийный номер аппаратного обеспечения |
| additional_info | string |
Required | Дополнительная информация |
| is_old | boolean |
Required | Флаг “старого” аппаратного обеспечения |
| service_asset | object<service_asset> |
Required | Связанный актив |
Service_asset
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор актива |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| type | string |
Required | Тип актива |
| name | string |
Required | Название актива |
| description | string |
Required | Описание актива |
| coordinates | string |
Required | Координаты актива (не используется). Значение по умолчанию - 0 |
| active | boolean |
Required | Флаг активности. Значение по умолчанию: true |
| scan_id | string |
Required | Идентификатор сканера |
| value | integer |
Required | Значимость актива. Значение по умолчанию: 3. Допустимые значения от 1 до 5 |
| client_note | string |
Required | Клиентские заметки (не используется) |
| internal_note | string |
Required | Внутренние заметки (не используется) |
| location | string |
Required | Расположение актива |
| network_exposure | integer |
Required | Сетевая видимость. Значение по умолчанию: 3. Допустимые значения от 1 до 5 |
| responsible_person | string |
Required | Ответственное лицо |
| technical_specialist | string |
Required | Технический специалист |
| responsible_group_id | string |
Required | Идентификатор группы ответственных |
| edited_by | string |
Required | Кем изменён (не используется) |
HardwareInfoEnrichResult
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| networkInterfaceId | string |
Required | IP-адрес актива ipv4 |
| hardwareInfo | Array<HardwareInformation> |
Required | Идентификатор учетной записи для сбора данных |
SoftwareInfo
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор программного обеспечения |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| name | string |
Required | Название программного обеспечения |
| raw_output_line | string |
Required | Необработанная строка данных (уникальное значение) |
| version | string |
Required | Версия |
| release | string |
Required | Релиз При создании из результата сканирования, совпадает с version. При сканировании ПО, не заполняется. |
| os | string |
Required | Операционная система |
| display_name | string |
Required | Название клиента (отображается в деталях инцидента) |
| description | string |
Required | Описание |
| software_group_id | string |
Required | Идентификатор группы ПО |
| tsvector | string |
Required | Используется для оптимизации поиска, заполняется автоматически (при создании и изменении объекта) из полей raw_output_line, name, version, release.Формат tsvector |
ScanSoftwareResult
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| os | string |
Required | Операционная система |
| softwareInfo | Array<SoftwareInfo> |
Required | Массив программного обеспечения |
SoftwareInfoEnrichResult
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| networkInterfaceId | string |
Required | Идентификатор сетевого интерфейса |
| os | string |
Required | Операционная система |
| softwareInfo | Array<SoftwareInfo> |
Required | Массив программного обеспечения |
DeviceUpdateInput
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| host | string |
Required | Список hostname |
| ipv4 | string |
Required | IP-адрес |
| mac | string |
Required | MAC-адрес |
NetworkInterface
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор сетевого интерфейса |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| name | string |
Required | Название сетевого интерфейса |
| ip | string |
Required | IP-адрес сетевого интерфейса |
| mac | string |
Required | MAC-адрес сетевого интерфейса |
| fqdn | Array<string> |
Required | Массив FQDN. |
| os | string |
Required | Операционная система |
| service_asset_id | string |
Required | ID связанного актива |
| edited_by | string |
Required | Идентификатор пользователя внесшего изменения |
| has_service_asset | boolean |
Required | Флаг, обозначающий наличие связанного актива |
| service_asset_name | string |
Required | Название связанного актива |
| service_asset_location | string |
Required | Расположение связанного актива |
| service_asset_value | integer |
Required | Значимость связанного актива |
| service_asset_network_exposure | integer |
Required | Сетевая видимость связанного актива |
| service_asset_group_names | Array<string> |
Required | Массив имен групп связанного актива |
| service_asset | object |
Required | Связанный актив |
| services | Array<object> |
Optional | Связанные сервисы |
| _relations | object |
Optional | Словарь, описывающий связанные модели через идентификаторы |
| _relations {services} | Array<string> |
Optional | Идентификаторы связанных сервисов |
DeviceUpdateResult
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| ipv4 | string |
Required | IP-адрес хоста |
| network_interface | object |
Required | Сетевой интерфейс Связи и доп. поля (связанные с активом) не заполняются и имеют значения по умолчанию |
| error_code | integer |
Required | Код ошибки. Возможные значения: - 0 — нет ошибки, - 13001 — недопустимый формат IP-адреса, - 13012 — недопустимый формат MAC (если указан), - 1497 — ошибка чтения из БД, - 1498 — ошибка обновления объекта в БД, - 1496 — ошибка создания объекта в БД, - 11002 — прочие ошибки БД. |
| error | string |
Required | Текст ошибки |