Get Link server settings

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Get Link server settings

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• link_enable boolean

  Default value: false

  Device should try to connect to Link server

• link_url ipv4 or dns

  URL for Link server

• link_password string

  Password used to login on Link server

• realtime_logging boolean

  Default value: true

  If enabled device will send logs on server

• heartbeat boolean

  If enabled device will send heartbeat to server to indicate that connection is still alive

{
  "link_enable": false,
  "link_url": "link.bas-ip.com",
  "link_password": "123abc",
  "realtime_logging": true,
  "heartbeat": true
}

{
  "link_enable": false,
  "link_url": "link.bas-ip.com",
  "link_password": "123abc",
  "realtime_logging": true,
  "heartbeat": true
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Describes the base error user might get

  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

  Describes the parameter that did not pass a validation

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

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

Loading...