State

Read the general state of the device

The general state tells whether the device is idle or busy with an operation that must not be interrupted. While the state is not idle, requests that start another such operation (reboot, shutdown, factory reset, firmware update) are rejected with 409 Conflict and the message Cannot perform a daemon operation, the system is busy with some other task, see general_state.state.

API

• Get the general state

  • Path: /api/state

  • Method: GET

  • Minimum user role: none (no token required)

  • Response on success (200 OK):

    {
        "message": "Success",
        "data": {
            "state": "idle",
            "comment": "",
            "last_error_time": 1790585449,
            "last_error": "could not update the product"
        }
    }

    • state - one of:
      • idle - no long-running operation in progress
      • restarting - a reboot, shutdown or factory reset has been accepted and the device is about to go down
      • updating - a firmware update is in progress (comment is updating the device); on IOTA 10 CORE PLUS also an FPGA reprogramming (comment is reprogramming the FPGA)
    • comment - short description of the running operation, for example reboot, shutdown, factory reset; empty when idle
    • last_error_time - epoch seconds of the last failed operation, 0 if none
    • last_error - message of the last failed operation, empty if none. The two last_error fields keep their values when the state returns to idle.

Back to Index