Software Update Service v2.0
Created Dec 18, 2020 at 07:09 PM

Resource: image

Information about the update image

http://{device}/api/npm.system_update/2.0/images/items/{id}
  • JSON
  • {
      "checksum": string,
      "id": integer,
      "progress": number,
      "state": string,
      "state_description": string,
      "version": string
    }
    Property Name Type Description Notes
    image <object> Information about the update image Required properties: [state, state_description];
    image.checksum <string> The SHA-256 checksum of the update image Optional;
    image.id <integer> A unique identifier for the image Read-only; Optional;
    image.progress <number> The progress of the current upload/fetch operation Optional;
    image.state <string> The state of the update image Values: UPLOADING, VALIDATING, UPLOAD_ERROR, VALID, INVALID;
    image.state_description <string> A more detailed description of the state
    image.version <string> The version of the update image Optional;

    Resource: images

    List of update images

    http://{device}/api/npm.system_update/2.0/images
  • JSON
  • {
      "items": [ image ]
    }
    Property Name Type Description Notes
    images <object> List of update images
    images.items <array of <image>> An array containing the available update images Optional;
    images.items[items] <image> Information about the update image

    Resource: update

    The overall status of the update

    http://{device}/api/npm.system_update/2.0/update
  • JSON
  • {
      "last_state_time": integer,
      "state": string,
      "state_description": string,
      "target_version": string,
      "update_history": [
        {
          "time": integer,
          "version": string
        }
      ]
    }
    Property Name Type Description Notes
    update <object> The overall status of the update Required properties: [state, state_description, last_state_time, update_history];
    update.last_state_time <integer> The time of the last state transition, in Unix epoch seconds
    update.state <string> The state of the update Values: IDLE, INITIALIZING, INITIALIZED, RUNNING, FAILED_GRACEFUL, FAILED_CRITICAL;
    update.state_description <string> A more detailed description of the state
    update.target_version <string> The version the system will be updated to Optional;
    update.update_history <array of <object>> A list of past updates. The first element of the list is an installation
    update.update_history[items] <object> Information about a previous update
    update.update_history[items].time <integer> The time of the update, in Unix epoch seconds Optional;
    update.update_history[items].version <string> The version that was installed Optional;