Check firmware status

Returns info about latest firmware version on the server

Responses

• 200
• 401
• 503

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• is_latest_version_installed boolean

  Check is the latest version installed or not

• latest_version_from_cloud object

  This attribute describes info about latest model available in cloud

  name string

  Firmware version

  date string

  Firmware release date

  description string

  Possible values: <= 2000 characters

  Firmware changelog

{
  "is_latest_version_installed": false,
  "latest_version_from_cloud": {
    "name": "2.0.0",
    "date": "04.04.2018",
    "description": "Something changed"
  }
}

{
  "is_latest_version_installed": false,
  "latest_version_from_cloud": {
    "name": "2.0.0",
    "date": "01.12.2020",
    "description": "Something changed"
  }
}

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

Update error

application/json

• Schema
• Example (from schema)
• Can't connect to update server
• Wrong firmware info on update server

---

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": "system_error",
    "message": "Can't connect to update server"
  }
}

{
  "error": {
    "code": "system_error",
    "message": "Wrong firmware info on update server"
  }
}

Loading...