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

Запрос

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

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

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


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

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

Параметр	Тип	Обязательность	Описание
_	`Array<SoftwareInfoEnrich>`	Required	Массив объектов
_{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>`	Массив объектов программного обеспечения
_{assetId}	`string`	Идентификатор актива
_{error}	`string`	Ошибка для данного актива
_{error_code}	`integer`	Код ошибки. Возможные варианты - 13004 — Не задан assetId - 13005 — Недопустимый формат assetId - 13006 — Не задан credentialId - 13007 — Недопустимый формат credentialId - 13008 — Не задан параметр type - 13009 — Недопустимое значение type - 13010 — Актив не найден - 13011 — Учетная запись не найдена - 11002 — Прочие ошибки
_{results}	`Array<SoftwareInfoEnrichResult>`	Актуальное ПО для интерфейсов
_results{networkInterfaceId}	`string`	ID сетевого интерфейса
_resultsos	`string`	Операционная система
_resultssoftwareInfo	`Array`<SoftwareInfo>	Массив программного обеспечения

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


{
  "_": [
    {
      "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
      "error": "string",
      "error_code": 0,
      "results": [
        {
          "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`	`Bad Request` `empty request`	Неверный тип параметра запроса, либо отсутствует обязательный параметр Пустой запрос или передан пустой массив
`500`	`Internal Server Error`	Другие ошибки при удалении объектов

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

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

   
Код 400   

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



   
Код 500   

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