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
• protocol string required

  Possible values: [http, mqtt]

• settings object required

  oneOf

  • MOD1
  • MOD2

  ---

  url ipv4 or dns required

  Server address

  password string required

  is_logging_enabled boolean required

  is_encrypted boolean required

  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

  is_logging_enabled boolean required

  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
• Missed json body
• Wrong protocol
• Wrong parameter type
• Required field is not provided.

application/json

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

---

Schema

• error object

  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

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

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "settings.url": [
        "not valid"
      ]
    }
  }
}

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "protocol": [
        "not valid"
      ]
    }
  }
}

{
  "error": {
    "code": "not_valid",
    "message": "Wrong JSON body",
    "data": {
      "protocol": [
        "Required parameter missed"
      ]
    }
  }
}

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "is_enabled": [
        "must be a boolean"
      ]
    }
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  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

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

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

Loading...