Get management server settings

Returns the management server configuration.

If Link is enabled, the server will sync identifiers, access rules, logs, etc.

If realtime logging is enabled, the device will send logs to the server in real time.

If heartbeat is enabled, the device will send a keep-alive to the server every 10 seconds. When the MQTT protocol is used, heartbeat is enabled by default.

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Mqtt
• Http

---

Schema

• is_enabled boolean

  Determines whether the Link server interaction is enabled

• protocol string

  Possible values: [http, mqtt]

  Defines the protocol for interaction with the Link server

• settings object

  Determines protocol-specific settings

  anyOf

  • MOD1
  • MOD2

  ---

  url ipv4|dns

  Server address

  password string

  Device Link server authorization password

  is_encrypted boolean

  Enables TLS encryption for the MQTT connection. A custom certificate can be uploaded with POST /network/management/server/certificate; otherwise the built-in default is used.

  url string

  Server address. Address must include http(s):// prefix

  password string

  Device Link server authorization password

  is_heartbeat_enabled boolean

  If enabled device will send keep alive request every 10 seconds

{
  "is_enabled": true,
  "protocol": "mqtt",
  "settings": {
    "url": "link.bas-ip.com",
    "password": "123abc",
    "is_encrypted": false
  }
}

{
  "is_enabled": false,
  "protocol": "mqtt",
  "settings": {
    "url": "link.bas-ip.com",
    "password": "123abc",
    "is_encrypted": true
  }
}

{
  "is_enabled": false,
  "protocol": "http",
  "settings": {
    "url": "link.bas-ip.com",
    "password": "123abc",
    "is_heartbeat_enabled": true
  }
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error information

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...