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 - panel will send the logs in realtime to the server.

If heartbeat is enabled - panel will send keep alive to the server every 10 seconds. When 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

  enable/disable connection to external management server

• protocol string

  Possible values: [http, mqtt]

  Which connection protocol will be used MQTT/HTTP

• settings object

  This attribute is used to describe all needed settings for the connection to the management server depending on the protocol used

  oneOf

  • MOD1
  • MOD2

  ---

  url ipv4 or dns

  Server address

  password string

  password on the server needs to match password on the device for it to be able to connect

  is_logging_enabled boolean

  If enabled device will send realtime logs to the server

  is_encrypted boolean

  If enabled you can provide custom certificate with POST /network/management/settings/certificate or device will use default one.

  url ipv4 or dns

  Server address

  password string

  password on the server needs to match password on the device for it to be able to connect

  is_logging_enabled boolean

  If enabled device will send realtime logs to the server

  is_heartbeat_enabled boolean

  If enabled device will send keep alive request every 10 seconds

{
  "is_enabled": true,
  "protocol": "http",
  "settings": {
    "url": "link.bas-ip.com",
    "password": "123abc",
    "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": "link.bas-ip.com",
    "password": "123abc",
    "is_logging_enabled": true,
    "is_heartbeat_enabled": true
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  object containing info about error

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  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

  extended info on error

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

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...