uploadFirmware

Use the interface to upload device firmware file(.mwf) to Cloud.

Only available for users with administrative rights.

After uploading successfully, the firmware needs to be accepted by Cloud using add-firmware, then it can be used to update hosted devices.

Prototype

Protocol	HTTP/HTTPS POST
URL	ip[:port]/sc_cloud/uploadFirmware
Data Format	Request: Content-Type: multipart/form-data; boundary=xxx Response: Content-Type: application/json

Request Cookies

Parameter	Description
mwcloud-sid	A string value that is used to uniquely identify user logged-in.
mwcloud-uid	Current logged-in username.

Request Body

A firmware file example is shown as follows.

Request Example

POST /sc_cloud/uploadFirmware HTTP/1.1
Content-Type: multipart/form-data; boundary=---------------------------42288931224667793852045763104
Content-Length: 14556621
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;

-----------------------------42288931224667793852045763104
Content-Disposition: form-data; name="file"; filename="ultra_stream_sdi_rev_a_1_5_79.mwf"
Content-Type: application/octet-stream
...
-----------------------------42288931224667793852045763104--

Response Parameters

Response Header

Parameter	Description
Content-Type	Value: 'application/json; charset=UTF-8'

Response Body

Parameter	Description
result	Result code. The options are as follows: 0: success. Other values. For details about the result codes, please refer to API Status.
file-path	File saved path on Cloud.
file-size	Size of firmware file.
firmware-info	Information of uploaded firmware file.

firmware-info

Parameter	Description
product-id	Product model ID.
firmware-id	Firmware type. 1 indicates test version. The others are released revisions.
marjor-ver	Main version.
minor-ver	minor version.
build-number	Build number.
build-time	Version build time.
product-name	Product model name.
hardware-ver	Hardware version of device.

This version number is physically represented as a three-part string with the following format:

<marjor version>.<minor version>.<build number>

For example, version 1.5.79. indicates 1 as the major version, 5 as the minor version, and 79 as the build number.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 285
{
  "result": 0, 
  "file-path": "/data/new-firmware-6.mwf",
  "file-size": 14556364,
  "firmware-info": {
    "product-id": 770,
    "firmware-id": 0,
    "marjor-ver": 1,
    "minor-ver": 5,
    "build-number": 79,
    "build-time": "2021-05-13 05:27:59",
    "product-name": "Ultra Stream SDI",
    "firmware-name": "Standard",
    "hardware-ver": "A"
  }
}

Magewell Cloud