Get firmware version and upgrade status

1. API Description

This API is used to get the current firmware version and upgrade status.

Request mode: POST [ip]/api/upgrade/state

Administrator Rights Logged-in
Yes Yes

2. Input Parameters

None

3. Output Parameters

Name Type Description
status Int Status code
state Int The task execution status
0: Idle
1: Initialize and upgrade
2: Upgrading
3: Upgraded
4: Online firmware downloading
cur-ver String The current firmware version
update-version String The latest firmware version
num-steps Int The total number of steps for upgrade, only available when state is 2
step Int The current step number, only available when state is 2
step-name String The name of the current step, only available when state is 2
step-progress Int The progress of the current step, only available when state is 2
Value range: 0 - 100
Unit: %
download-percent Float The percentage of online download

4. Example

Getting the current firmware version and upgrade status.

Input Example
None
Output Example
{
  "status": 0,
  "state": "updating",
  "cur-ver": "1.1.72",
  "update-version": "1.1.72",
  "num-steps": 4,
  "step": 2,
  "step-name": "Erasing image",
  "step-progress": 28
}

5. Error Code

No error code related to the API business logic. For other error codes, see Common Error Codes.

results matching ""

    No results matching ""