Обновление данных о программном обеспечении

Запрос

Тип	Метод
`POST`	`/sonar/software/gather`

Описание: При выполнении запроса будет выполнено сканирование программного обеспечения на активе. Использует IP сетевого интерфейса актива (первый в базе, если несколько).

Создаёт/обновляет software в БД, удаляет старые данные.

Возвращает идентификатор сетевого интерфейса и его актуальное программное обеспечение.

Пример запроса


POST
http://127.0.0.1/cruddy/v2/sonar/software/gather

Тело запроса:

Параметр	Тип	Обязательность	Описание
assetId	`string`	Required	ID актива
credentialId	`string`	Required	ID учетной записи сбора данных
type	`string`	Required	Тип подключения. Допустимые значения: - ssh - rpc - wmi

Пример тела запроса


{
  "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  "credentialId": "f568fec0-10b6-4b94-9daf-e62c50c9bf3e",
  "type": "ssh"
}

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Параметры ответа:

Параметр	Тип данных	Описание
_	`Array<SoftwareInfoEnrichResult>`	Массив объектов программного обеспечения
_{networkInterfaceId}	`string`	ID сетевого интерфейса
_{os}	`string`	Операционная система
_{softwareInfo}	`Array`<SoftwareInfo>	Массив программного обеспечения

Пример ответа


{
  "_": [
    {
      "networkInterfaceId": "29d425c3-7721-4ca1-9d9e-271f2746c0b6",
      "os": "string",
      "softwareInfo": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created_at": "2023-12-20T00:00:01.652259Z",
          "updated_at": "2023-12-20T00:00:01.652259Z",
          "name": "string",
          "raw_output_line": "string",
          "version": "string",
          "release": "string",
          "os": "string",
          "display_name": "",
          "description": "string",
          "software_group_id": "d7939ec9-4754-44e2-b522-27172eae4658",
          "tsvector": "'17':4,12 '17.5.2.1':8,16,17 'driver':3,11 'for':5,13 'microsoft':1,9 'odbc':2,10 'server':7,15 'sql':6,14"
        }
      ]
    }
  ]
}

Другие возможные ответы

Код	Ответ	Описание
`400`	`1. Bad Request` `2. credential id is empty` `3. asset id is empty` `4. type is empty` `5. asset id should be uuid format` `6. credential id should be uuid format` `7. invalid type` `8. network interfaces not found`	1. Неверный тип параметра запроса, либо отсутствует обязательный параметр 2. Учетная запись не задана 3. Актив не задан 4. Тип подключения не задан 5. Недопустимый формат assetId 6. Недопустимый формат credentialId 7. Недопустимое значение поля `type` 8. Не найдены сетевые интерфейсы для переданного актива
`404`	`service asset not found` `credential not found`	Актив не найден Учетная запись не найдена
`500`	`Internal Server Error`	Другие ошибки при удалении объектов

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

   
Код 400   

{
  "error": "Bad Request",
  "error_code": 400
}



   
Код 404   

{
  "error": "Not Found",
  "error_code": 404
}



   
Код 500   

{
  "error": "Internal Server Error",
  "error_code": 500
}