Management app

These operations (on Encedo PPA only) allow the build-in management application to be upgraded. This includes integrity and signature validation allowing only a legitimate application to be installed.

Embedded Flash Drive is available on Encedo PPA only. On Encedo EPA those endpoints are not available, response code 404 will be returned.

Allowed users

User

Allowed

Master

Allowed

ExtAuth

Allowed

Required access scope

Main

system:upgrade

Alternative

system:config

The Authorization header is not required on fresh, not personalized devices.

TLS connection is not required. It is a last resort way to upload fixes. Firmware is signed anyway, no worry about the integrity and genuine.

Upload a file

Upload a new file

POST https://my.ence.do/api/system/upgrade/upload_ui

Upload a new app image (webroot.tar) file.

Headers

Name	Type	Description
Authorization	String	Bearer JWT_TOKEN
Content-Type*	String	application/octet-stream
Content-Disposition*	String	attachment; filename="webroot.tar"
Expect*	String	100-continue

200: OK Operation sucessful

401: Unauthorized Missing or invalid JWT_TOKEN

403: Forbidden Incorrect access scope

406: Not Acceptable Operation failed

Log entries

Event	Result	Source
LOG_TYPE_FAILED_SCOPE_CHECK	LOG_RESULT_FAILED	403

Validate a file

Check a file

GET https://my.ence.do/api/system/upgrade/check_ui

Check the signature and integrity of the new ulpoaded app image.

Headers

Name	Type	Description
Authorization	String	Bearer JWT_TOKEN

200: OK Operation sucessful

201: Created Process of validation started

401: Unauthorized Missing or invalid JWT_TOKEN

403: Forbidden Incorrect access scope

406: Not Acceptable Operation failed

202: Accepted Process of validation ongoing

Log entries

Event	Result	Source
LOG_TYPE_FAILED_SCOPE_CHECK	LOG_RESULT_FAILED	403

Install new management app

Install new management app

GET https://my.ence.do/api/system/upgrade/install_ui

A new version of Encedo Manager will be installed on Encedo PPA.

Headers

Name	Type	Description
Authorization	String	Bearer JWT_TOKEN

200: OK Operation sucessful

401: Unauthorized Missing or invalid JWT_TOKEN

403: Forbidden Incorrect access scope

409: Conflict Incorrect internal state

406: Not Acceptable Operation failed

Log entries

Event	Result	Source
LOG_TYPE_FAILED_SCOPE_CHECK	LOG_RESULT_FAILED	403
LOG_TYPE_UPGRADE	LOG_RESULT_ERROR	406
LOG_TYPE_UPGRADE	LOG_RESULT_ERROR	409
LOG_TYPE_UPGRADE	LOG_RESULT_OK	200