13 / 48
The reproduction, distribution and utilization of this document as well as the communication of its contents to others without
express authorization is prohibited. Offenders will be held liable for the payment of damages.
All rights reserved in the event of the grant of patent, utility model or design.
14.04.2020
Version 1.18.0
Update
REST
4 Update
To perform a firmware update post the URL to the update .tar file to the device.
Request
Name
update
URL
https://[deviceIP]:[restPort]/apiv1/update
Availability
APS-RS firmware 1.10
Method
Data
Result
HTTP Status
Comments
GET
—
not supported
403 - Forbidden
POST
JSON Container
with update
information
NONE
200 - OK on success
400 - Bad Request on internal
error → additional information in
JSON error payload
401 - Unauthorized – The request
requires an user authentication
PUT
—
not supported
405 - Method Not Allowed
DELETE
—
not supported
405 - Method Not Allowed
Contents of an update request
■
Update_type
●
Enumeration specifying the type of update
●
Currently only "UPDATE_FIRMWARE" is supported
■
Packet_url
●
String, maxLen: 255 characters
●
URL to the update file
■
Validity
●
Unsigned integer
●
Min: 1h, max: 168 h (one week), default: 48h
●
Specifies the time period, in which the device shall perform retries in case an update fails
