Encedo HEM API Developer Manual
  • Welcome!
  • Preliminary
    • Quick Start
    • General information
  • Security
    • Report an issue
    • Advisory
      • Hall of fame
  • Reference
    • API Reference
      • System
        • Version & Status
        • Checkin
        • Configuration
        • Upgrade
          • Firmware
            • Low level USB mode
          • Management app
        • Self-test
        • Reboot
        • Shutdown
      • Authorization
        • Initialization
        • User authentication
        • External authenticator
          • Registration
          • Authentication
      • Key Management
        • Create a key
        • Derive a key
        • Import a key
        • Update a key
        • Delete a key
        • Get a public key
        • List the keys
        • Search a key
      • Cryptography operations
        • HMAC
        • ExDSA
        • ECDH
        • Encryption
          • Encryption/Decryption
          • Wrap/Unwrap
      • Audit log
      • Storage
Powered by GitBook
On this page
  • Upload a file
  • Upload a new file
  • Validate a file
  • Check a file
  • Install new management app
  • Install new management app
  1. Reference
  2. API Reference
  3. System
  4. Upgrade

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

Allowed

Allowed

Allowed

Required access scope

system:upgrade

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

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

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

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

PreviousLow level USB modeNextSelf-test

Last updated 3 years ago