Перейти к содержанию

Обнаружение хостов

Запрос

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

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

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

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

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

Параметр Тип данных Обязательность Описание
subnet string Required Адрес подсети для сканирования в формате CIDR
Пример тела запроса

{
  "subnet": "192.168.1.0/24"
}

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

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

Формат: JSON.

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

Параметр Тип данных Описание
_ Array<ScanDeviceResult> Массив хостов
_{ipv4} string IP-адрес
_{mac} string MAC-адрес
_{ipv6} string IP-адрес v6
Пример ответа

{
  "_": [
    {
      "host": [
        "string"
      ],
      "ipv4": "192.168.0.1",
      "mac": "string",
      "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
    }
  ]
}

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

Код Ответ Описание
400 Bad Request
subnet is empty
subnet format:
Неверный тип параметра запроса, либо отсутствует обязательный параметр
Подсеть не задана
Ошибка в формате подсети
500 Internal Server Error Другие ошибки при удалении объектов

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

Пример ответа
Код 400

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

Код 500

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