Поиск хостов уязвимостей
Запрос
| Тип | Метод |
|---|---|
POST |
/vulnerability_hosts/search |
Описание: При выполнении запроса будут возвращены найденные объекты с учётом заданных фильтров.
По умолчанию в объекты не загружаются связанные модели по типам связи many2many и has-many, для включения загрузки их нужно указывать в поле relations объекта запроса.
Связи _relations загружаются всегда и отражают текущее состояние связей модели.
Пример запроса
POST
http://127.0.0.1/cruddy/v2/vulnerability_hosts/search
Тело запроса:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| include_fields | Array<string> |
Required | Список полей для выборки. Если модель содержит поля, не указанные в запросе, они будут отсутствовать в ответе |
| exclude_fields | Array<string> |
Required | Список полей для удаления из выборки. Если модель содержит поля, указанные в запросе, они будут отсутствовать в ответе |
| filters | Array<filters> |
Required | Список фильтров по полям модели |
| ordering | Array<ordering> |
Required | Настройки сортировки |
| virtual_search | object<virtual_search> |
Required | Поле для поиска по подстроке по всем строковым полям модели и настройка строгого поиска |
| relations | Array<string> |
Required | Список связей для выборки. Список доступных связей отображается в ответе запроса на получение метаданных - “/_meta” |
| limit | integer |
Required | Лимит выдачи найденных объектов |
| offset | integer |
Required | Отступ от начала результата поиска в базе |
| _relations | Array<string> |
Optional | Перечисление связанных сущностей идентификаторы которых нужно вернуть в ответе в поле _relations |
Array of filters
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| field | string |
Required | Название поля модели |
| value | object |
Required | Значение для фильтрации |
| filter_type | string |
Required | В зависимости от этого значения определяется допустимые значения в поле value. Допустимые значения:- equal -> строка|число, проверяет равенство значений - substr -> строка, проверяет вхождение подстроки - intersection -> массив (тип элемента зависит от типа поля), проверяет вхождение значения поля в переданный массив - range -> массив (тип элемента зависит от типа поля), проверяет вхождение значения поля в переданный диапазон - related -> строка или массив строк (uuid), проверят связанность с моделью по идентификатору если value: [], проверяет наличие или отсутствие связанных сущностей- exists -> значение отсутствует, проверяется равенство колонки с null |
| negation | boolean |
Optional | Флаг использования отрицания при проверке фильтра |
Array of ordering
| Параметр | Тип | Обязательность | Описание / Допустимые значения |
|---|---|---|---|
| field | string |
Required | Поле модели выбранное для сортировки |
| direction | string |
Required | Направление сортировки. Допустимые значения: - asc - desc |
Object VirtualSearch
| Параметр | Тип | Обязательность | Описание / Допустимые значения |
|---|---|---|---|
| value | string |
Required | Значение выбранное для поиска |
| strict | boolean |
Required | Опция, включающая строгий поиск. Возможные значения: - true - строгий поиск включена;- false - строгий поиск выключен. |
Пример тела запроса
{
"include_fields": [
"string"
],
"exclude_fields": [
"string"
],
"filters": [
{
"field": "string",
"value": [
"name",
[
"value1",
"value2"
]
],
"filter_type": "equal",
"negation": false
}
],
"ordering": [
{
"field": "string",
"direction": "asc"
}
],
"virtual_search": {
"value": "string",
"strict": false
},
"relations": [
"service_asset_findings",
"logmule_go_rules",
"user"
],
"limit": 20,
"offset": 0,
"_relations": [
"string"
]
}
Успешный ответ
Статус код: 200 – успешный ответ.
Формат: JSON.
Параметры ответа:
| Параметр | Тип данных | Описание |
|---|---|---|
| items | Array <VulnerabilityHost> |
Список найденных хостов |
| total | integer |
Количество найденных хостов |
Пример ответа
{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"ip": "192.168.0.1",
"mac": "string",
"fqdn": "string",
"properties": "string",
"scan_begin": null,
"scan_end": null,
"service_asset_id": "09122f07-8b1e-48dc-96fd-379806f6c51e",
"vulnerability_scan_id": "b72752e1-e814-4606-9275-f2ac9ca468b7",
"os": "string",
"authenticated": true,
"scan_error": "string",
"name": "string",
"authentication_info": {
"key1": {
"nestedKey": "nestedValue"
},
"key2": [
"listItem1",
"listItem2"
],
"key3": 42,
"key4": null
},
"vulns_count": 0,
"v0_count": 0,
"v1_count": 0,
"v2_count": 0,
"v3_count": 0,
"v4_count": 0,
"installed_software_count": 0,
"service_asset": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"type": "Host",
"name": "Актив",
"description": "Описание актива",
"coordinates": "--- []",
"active": true,
"scan_id": "9a59f0f5-5572-476d-a7fc-c960ef43a5af",
"value": 3,
"client_note": "string",
"internal_note": "string",
"location": "string",
"network_exposure": 3,
"responsible_person": "string",
"technical_specialist": "string",
"responsible_group_id": "2d40d7ca-3218-4132-89ef-42e29379a567",
"edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c"
},
"vulnerability_scan": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z"
},
"vulnerabilities": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"plugin_id": "8b176ba5-fa8e-458e-94ad-85d1ae8f3be0",
"plugin_name": "string",
"description": "string",
"severity": 0,
"additional_data": {},
"protocol": "string",
"port": 0,
"occurrence_id": "8508ee33-23a1-4a06-ae02-1eb167405e7b",
"synopsis": "string",
"vulnerability_host_id": "f7091c30-f117-455e-9531-6af6bb5ece68",
"exploitable": true,
"plugin_output": "string",
"solution": "string",
"compare_port": -1,
"compare_protocol": "",
"service_asset_id": "09122f07-8b1e-48dc-96fd-379806f6c51e",
"vulnerability_scan_id": "b72752e1-e814-4606-9275-f2ac9ca468b7",
"external": false,
"remote_exploitable": false,
"cvss_vector": "string",
"cvss_temporal_vector": "string",
"cvss_base_score": 0,
"cvss_temporal_score": 0,
"risk_factor": "string",
"plugin_modification_date": "string",
"publication_date": "string"
}
],
"_relations": {
"vulnerabilities": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}
],
"total": 1
}
Другие возможные ответы
| Код | Ответ | Описание |
|---|---|---|
400 |
Bad Request |
Неверный тип параметра запроса, либо отсутствует обязательный параметр |
500 |
Internal Server Error |
Другие ошибки сервера |
Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.
Пример ответа
Код 400
{
"error": "Bad Request",
"error_code": 400
}
Код 500
{
"error": "Internal Server Error",
"error_code": 500
}