Set management server settings

Set management server settings.

If Link is enabled - Link 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.

application/json

Request Body required

• is_enabled boolean required

  If management server is enabled

• protocol string required

  Possible values: [http, mqtt]

  Server interaction protocol

• settings object required

  Protocol settings

  anyOf

  • MOD1
  • MOD2

  ---

  url ipv4 or dns

  Server address

  password string

  Server authorization password

  is_logging_enabled boolean

  Panel will send logs to 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.

  url ipv4 or dns required

  Server address

  password string required

  Server authorization password

  is_logging_enabled boolean required

  Panel will send logs to server if option is enabled

  is_heartbeat_enabled boolean required

  If enabled device will send keep alive request every 10 seconds

Responses

• 200
• 400
• 401

---

OK

Validation error.

• Wrong url
• Wrong password
• Missed json body
• Wrong protocol
• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Wrong url
• Wrong password
• Wrong protocol
• Base
• No value
• Wrong param type

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong url"
}

{
  "error": "Wrong password"
}

{
  "error": "Wrong protocol"
}

{
  "error": "Missed json body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...