Get Cellular Module Firmware Configuration Status (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/machines/:machine_id/cellular_modules/:cellular_module_id/firmware/status

Get the cellular module firmware configuration status.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

machine_id stringrequired

The ID of the device.

cellular_module_id stringrequired

ID of the cellular module.

Responses

200

Successful Operation

application/json

Schema

Schema

download_interval integer

The firmware download interval. Valid download interval must be provided along with a valid download time.

id string

The ID of the cellular module firmware.

image_states CellularModuleFirmwareUpgradeImageState[]
List the image states.
Array [
current_carrier string
Current Carrier
current_fw_version string
Current Fw Version
current_pri_version string
Current Pri Version
download_percent integer
Download Percent
download_start string
Download Start
status string
Status
status_info string
Status Info
upgrade_carrier string
Upgrade Carrier
upgrade_fw_version string
Upgrade Fw Version
upgrade_location string
Upgrade Location
upgrade_pri_version string
Upgrade Pri Version
upgrade_start string
Upgrade Start
]
last_state_change string

Lists the last state change of the firmware.

scheduled_download string

The scheduled download of the firmware.

scheduled_upgrade string

The scheduled upgrade of the firmware.

upgrade_interval integer

The upgrade interval of the firmware. Valid upgrade interval must be provided along with a valid upgrade time.

Example (from schema)

{
  "download_interval": 0,
  "id": "string",
  "image_states": [
    {
      "current_carrier": "string",
      "current_fw_version": "string",
      "current_pri_version": "string",
      "download_percent": 0,
      "download_start": "string",
      "status": "string",
      "status_info": "string",
      "upgrade_carrier": "string",
      "upgrade_fw_version": "string",
      "upgrade_location": "string",
      "upgrade_pri_version": "string",
      "upgrade_start": "string"
    }
  ],
  "last_state_change": "string",
  "scheduled_download": "string",
  "scheduled_upgrade": "string",
  "upgrade_interval": 0
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "CELLULAR_MODULE_FW_CONFIG_STATUS_NOTFOUND"
      }
    ]
  }
}

Loading...