Отримати статус мережі

GET 
/network

Отримати статус мережі

Responses

200

Статус мережі

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

networks

object

Список доступних мереж

ethernet

object

Налаштування мережі Ethernet

ip_settings

object

oneOf

IpSettingsStatic

typestring

Тип налаштувань IP

Example: static

ipstring

IP-адреса

Example: 192.168.1.100

netmaskstring

Маска підмережі

Example: 192.168.255.255

gatewaystring

Адреса шлюзу

Example: 192.168.1.1

dnsstring[]

DNS-сервер

Example: ["1.1.1.1","1.0.0.1"]

IpSettingsDhcp

typestring

Тип налаштувань IP

Example: dhcp

IpSettingsDhcpWithDns

typestring

Тип налаштувань IP

Example: dhcpwithdns

dnsstring[]

DNS-сервер

Example: ["1.1.1.1","1.0.0.1"]

enabledboolean

Включити мережу Ethernet

Example: true

statusNetworkStatus (string)

Статус мережі

Possible values: [disconnected, connecting, online, no_internet, unavailable, unknown]

wifi

object

Налаштування мережі Wi-Fi

enabledboolean

Включити мережу Wi-Fi

Example: true

ip_settings

object

oneOf

IpSettingsStatic

typestring

Тип налаштувань IP

Example: static

ipstring

IP-адреса

Example: 192.168.1.100

netmaskstring

Маска підмережі

Example: 192.168.255.255

gatewaystring

Адреса шлюзу

Example: 192.168.1.1

dnsstring[]

DNS-сервер

Example: ["1.1.1.1","1.0.0.1"]

IpSettingsDhcp

typestring

Тип налаштувань IP

Example: dhcp

IpSettingsDhcpWithDns

typestring

Тип налаштувань IP

Example: dhcpwithdns

dnsstring[]

DNS-сервер

Example: ["1.1.1.1","1.0.0.1"]

ssidstring

Ім'я мережі

Example: MyWifi

statusNetworkStatus (string)

Статус мережі

Possible values: [disconnected, connecting, online, no_internet, unavailable, unknown]

gsm

object

Налаштування мережі GSM

enabledboolean

Включити мережу GSM

Example: true

ip_settings

object

oneOf

IpSettingsStatic

typestring

Тип налаштувань IP

Example: static

ipstring

IP-адреса

Example: 192.168.1.100

netmaskstring

Маска підмережі

Example: 192.168.255.255

gatewaystring

Адреса шлюзу

Example: 192.168.1.1

dnsstring[]

DNS-сервер

Example: ["1.1.1.1","1.0.0.1"]

IpSettingsDhcp

typestring

Тип налаштувань IP

Example: dhcp

IpSettingsDhcpWithDns

typestring

Тип налаштувань IP

Example: dhcpwithdns

dnsstring[]

DNS-сервер

Example: ["1.1.1.1","1.0.0.1"]

apnstring

Назва точки доступу

Example: internet

statusNetworkStatus (string)

Статус мережі

Possible values: [disconnected, connecting, online, no_internet, unavailable, unknown]

reserve_switchingboolean
Включити автоматичне перемикання на резервну мережу
Example: true
reserve_networkstring
Назва резервної мережі
Possible values: [ethernet, wifi, gsm]
Example: ethernet

Example (from schema)

{
  "success": true,
  "networks": {
    "ethernet": {
      "ip_settings": {
        "type": "static",
        "ip": "192.168.1.100",
        "netmask": "192.168.255.255",
        "gateway": "192.168.1.1",
        "dns": [
          "1.1.1.1",
          "1.0.0.1"
        ]
      },
      "enabled": true,
      "status": "disconnected"
    },
    "wifi": {
      "enabled": true,
      "ip_settings": {
        "type": "static",
        "ip": "192.168.1.100",
        "netmask": "192.168.255.255",
        "gateway": "192.168.1.1",
        "dns": [
          "1.1.1.1",
          "1.0.0.1"
        ]
      },
      "ssid": "MyWifi",
      "status": "disconnected"
    },
    "gsm": {
      "enabled": true,
      "ip_settings": {
        "type": "static",
        "ip": "192.168.1.100",
        "netmask": "192.168.255.255",
        "gateway": "192.168.1.1",
        "dns": [
          "1.1.1.1",
          "1.0.0.1"
        ]
      },
      "apn": "internet",
      "status": "disconnected"
    }
  },
  "reserve_switching": true,
  "reserve_network": "ethernet"
}

400

Погане HTTP запитання

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4135,
  "errorMessage": "Required field is missing",
  "errorParameters": {
    "parameter": "name"
  }
}

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}