Get management server settings

Get management server settings.

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

If realtime logging is enabled - device will send the logs in realtime to the server.

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

Responses

application/json

Schema
Example (from schema)
Mqtt
Http

Schema

is_enabled boolean
Describes, if Link management server function is enabled on device
protocol string
Possible values: [http, mqtt]
Network protocol used to connect to the management server
settings object
Describes protocol settings for picked protocol
oneOf
MOD1
MOD2
url host
Server host address. Also port can be specified with colon
password ascii
Possible values: non-empty and <= 32 characters
Password use for authenticate device on Link server
is_logging_enabled boolean
Device send logs to Link server, if option is enabled
is_encrypted boolean
If enabled you can provide custom certificate with POST /network/management/settings/certificate or device will use default one.

{
  "is_enabled": true,
  "protocol": "http",
  "settings": {
    "url": "link.bas-ip.com",
    "password": "67d6f5as9d5fa9s8df",
    "is_logging_enabled": false,
    "is_encrypted": false
  }
}

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

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

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Example

Schema

error object
Error object, contains error details
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]
Error code
message string
Error message
data object
Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.
param string
Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Get management server settings​

Get management server settings