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 - 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.

application/json

Request Body required

• is_enabled boolean required

  Describes, if Link management server function is enabled on device

• protocol string required

  Possible values: [http, mqtt]

  Network protocol used to connect to the management server

• settings object required

  Describes protocol settings for picked protocol

  oneOf

  • MOD1
  • MOD2

  ---

  url host required

  Server host address. Also port can be specified with colon

  password ascii required

  Possible values: non-empty and <= 32 characters

  Password use for authenticate device on Link server

  is_logging_enabled boolean required

  Device send logs to Link server, if option is enabled

  is_encrypted boolean required

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

  url url required

  Server address

  password ascii required

  Possible values: non-empty and <= 32 characters

  Password use for authenticate device on Link server

  is_logging_enabled boolean required

  Device send logs to Link 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

Bad Request

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": "bad_request",
    "message": "Bad request sent"
  }
}

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"
  }
}

Loading...