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

  enable/disable connection to Link

• link_url ipv4 or dns

  address for used Link server

• link_password string

  password that needs to be used by Link server to establish connection with device

• realtime_logging boolean

  Default value: true

  If enabled device will send logs on server

• heartbeat boolean

  used for HTTP Link, sends heartbeat to server to indicate that device is still connected

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

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