Обнаружение программного обеспечения

Запрос

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

Описание: При выполнении запроса будет просканирован хост и возвращено найденное программное обеспечение.

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


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

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

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

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


{
  "ip": "192.168.0.1",
  "credentialId": "f568fec0-10b6-4b94-9daf-e62c50c9bf3e",
  "type": "ssh"
}

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

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

Формат: JSON.

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

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

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


{
  "_": [
    {
      "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. ip is empty` `4. type is empty` `5. credential id should be uuid format` `6. invalid type` `7. invalid IP`	1. Неверный тип параметра запроса, либо отсутствует обязательный параметр 2. Учетная запись не задана 3. IP-адрес не задан 4. Тип подключения не задан 5. Недопустимый формат credentialId 6. Недопустимое значение поля `type` 7. Недопустимый формат IP-адреса
`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
}