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

Запрос

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

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

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


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

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

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

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


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

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

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

Формат: JSON.

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

Параметр	Тип данных	Описание
_	`Array`<HardwareInformation>	Массив аппаратного обеспечения

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


{
  "_": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2023-12-20T00:00:01.652259Z",
      "updated_at": "2023-12-20T00:00:01.652259Z",
      "service_asset_id": "09122f07-8b1e-48dc-96fd-379806f6c51e",
      "hardware_type": "string",
      "name": "string",
      "manufacturer": "string",
      "serial_number": "string",
      "additional_info": "string",
      "is_old": true,
      "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"
      }
    }
  ]
}

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

Код	Ответ	Описание
`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. Не найдены сетевые интерфейсы для переданного актива
`404`	`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
}