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

::: page-constructor
blocks:
  - type: content-layout-block
    textContent:
      buttons:
        - text: Классический VCE
          theme: action
          width: 'auto'
        - text: Документация
          theme: outlined
          url: https://docs.ideco.ru/v22/ru/ngfw/settings/users/device-discovery
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::


{% cut "Получение состояния" %}

```
GET /netscan_backend/state/
```

**Ответ на успешный запрос:**

```json5
{
   "enabled": true | false
}
```

* `enabled` - опция раздела **Обнаружение устройств**: 
  * `true` - включена;
  * `false` - выключена.

{% endcut %}

{% cut "Изменение состояния" %}

```
PATCH /netscan_backend/state
```

**Json-тело запроса:**

```json5
{
   "enabled": true | false
}
```

* `enabled` - опция раздела **Обнаружение устройств**: 
  * `true` - включена;
  * `false` - выключена.

**Ответ на успешный запрос:** 200 OK

{% endcut %}

{% cut "Получение списка групп" %}

```
GET /netscan_backend/groups
```

**Ответ на успешный запрос:**

```json5
[
    {
       "group_alias_id":  "string",
       "name": "string"
    }
]
```

* `group_alias_id` - идентификатор группы, в которую добавлены обнаруженные устройства;
* `name` - название группы.

{% endcut %}

{% cut "Получение статуса" %}

```
GET /netscan_backend/status
```

**Ответ на успешный запрос:**

```json5
[
    {
        "name": "netscan_backend",
        "status": "active" | "inactive",
        "msg": [ "string" ]
    }
]
```

* `name` - название модуля Получение состояния Обнаружения устройств;
* `status` - текущий статус модуля:
  * `active` - работает;
  * `inactive` - остановлен.
* `msg` - список строк, поясняющих текущее состояние службы. Может быть пустым.

{% endcut %}

{% cut "Получение настроек" %}

```
GET /netscan_backend/settings
```

**Ответ на успешный запрос:**

```json5
{
   "group_alias_id": "string",
   "networks": [ "string" ]
}
```

* `group_alias_id` - идентификатор группы, в которую добавлены обнаруженные устройства;
* `networks` - список локальных сетей, устройства из которых будут автоматически добавлены и авторизованы на Ideco NGFW Novum.

{% endcut %}

{% cut "Изменение настроек" %}

```
PATCH  /netscan_backend/settings
```

**Json-тело запроса:**

```json5
{
   "group_alias_id": "string",
   "networks": [ "string" ]
}
```

* `group_alias_id` - идентификатор группы, в которую будут добавлены обнаруженные устройства;
* `networks` - список локальных сетей, устройства из которых будут автоматически добавлены и авторизованы на Ideco NGFW Novum.

**Ответ на успешный запрос:** 200 OK

{% endcut %}
