Core (2.2.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

systems

Export configurations

Authorizations:

bearerAuth

query Parameters

action required	string Default: "download" Enum: "download" "get-profile" action to be executed
encryption	boolean Default: true Use password to encryption (default:true)
password	string If encryption is true, use this field as password (default:serial number), which should contain a number and a special char. For example, the query parameter will be like `?action=download&encryption=true&password=1234567*`
select	any <string> Example: select=[{"app":"modbusmaster"},{"app":"cloud"}] select configurations by profiles. If no value is given, it will select all.
filter	any <string> Example: filter=[{"labels":["credential"]},{"labels":["network"]}] filter configurations by profiles. It will do `select` first, then do `filter`.

Responses

Response samples

200

Content type

application/json

{"count": 21,
"data": [{"app": "system",
"labels": [ ],
"section": "core"
},
{"app": "device",
"labels": ["network"
],
"section": "cellulars"
},
{"app": "device",
"labels": [ ],
"section": "dhcpservers"
},
{"app": "device",
"labels": [ ],
"section": "discovery"
},
{"app": "device",
"labels": ["network"
],
"section": "ethernets"
},
{"app": "device",
"labels": [ ],
"section": "firewall"
},
{"app": "device",
"labels": [ ],
"section": "general"
},
{"app": "device",
"labels": [ ],
"section": "gps"
},
{"app": "device",
"labels": [ ],
"section": "iptables"
},
{"app": "device",
"labels": [ ],
"section": "minicards"
},
{"app": "device",
"labels": ["network"
],
"section": "route"
},
{"app": "device",
"labels": [ ],
"section": "serials"
},
{"app": "device",
"labels": [ ],
"section": "time"
},
{"app": "device",
"labels": ["network"
],
"section": "wifi"
},
{"app": "cloud",
"labels": [ ],
"section": "core"
},
{"app": "edge-web",
"labels": [ ],
"section": "core"
},
{"app": "eipscanner",
"labels": [ ],
"section": "core"
},
{"app": "function",
"labels": [ ],
"section": "core"
},
{"app": "modbusmaster",
"labels": [ ],
"section": "core"
},
{"app": "opcuaserver",
"labels": [ ],
"section": "core"
},
{"app": "tagservice",
"labels": [ ],
"section": "core"
}
]
}

Upload configurations

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

apply	boolean Default: false Apply configuration and will check if model name or version has conflict.
encryption	boolean Default: true Use password to encryption (default:true)
file	string <binary> configuration file
password	string password (default:serial number)

Responses

Response samples

200
400

Content type

application/json

Example

Both different

{"data": {"diff": {"current": {"model": "uc-3100",
"tpeversion": "2.0.0-1600"
},
"imported": {"model": "uc-8100-lx",
"tpeversion": "1.1.0-1234"
}
},
"fileName": "2019-12-19-13-52-backup.tar.gz",
"fileSize": 46272
}
}

Apply configuration

Apply configuration that uploaded by PUT /system/configuration. After applying configuration, system will be rebooted in 5 seconds.

Authorizations:

bearerAuth

path Parameters

filename

required

string

The filename value returned in the response the filename in PUT /system/configuration.

Responses

Response samples

200

Content type

application/json

{"data": {"diff": null,
"fileName": "2019-12-20-04-51-backup.tar.gz",
"fileSize": 46297
}
}

Get discovery service status

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"enable": true
}
}

Set discovery service configuration

Authorizations:

bearerAuth

Request Body schema: application/json

enable

boolean

enable discovery service

Responses

Request samples

Payload

Content type

application/json

{"enable": true
}

Response samples

200

Content type

application/json

{"data": {"enable": true
}
}

Get httpserver configuration

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"certFileName": "default.crt",
"httpEnable": true,
"httpPort": 80,
"httpsEnable": true,
"httpsPort": 443,
"keyFileName": "default.key"
}
}

Set httpserver configuration partially

Authorizations:

bearerAuth

Request Body schema: application/json

cert	string (JSON only) certificate content
certFile	string <binary> (form-data only) certificate for https. The suffix of filename must be one of `.crt`, `.cer` or `.pem` with PEM format which the content starts with `----- BEGIN CERTIFICATE -----`
certFilename	string (JSON only) filename of client authentication certificate
httpEnable	boolean
httpPort	integer listen port for http
httpsEnable	boolean
httpsPort	integer listen port for https
key	string (JSON only) key content
keyFile	string <binary> (form-data only) key for https. The suffix of filename must be one of `.key`, `.pk` or `.pem` with PEM format which the content starts with `----- BEGIN RSA PRIVATE KEY -----`
keyFilename	string (JSON only) filename of client authentication key

Responses

Request samples

Payload

Content type

application/json

{"cert": "string",
"certFile": "string",
"certFilename": "string",
"httpEnable": true,
"httpPort": 0,
"httpsEnable": true,
"httpsPort": 0,
"key": "string",
"keyFile": "string",
"keyFilename": "string"
}

Response samples

200

Content type

application/json

{"data": {"certFileName": "default.crt",
"httpEnable": true,
"httpPort": 80,
"httpsEnable": true,
"httpsPort": 443,
"keyFileName": "default.key"
}
}

Set httpserver configuration

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

cert	string (JSON only) certificate content
certFile	string <binary> (form-data only) certificate for https. The suffix of filename must be one of `.crt`, `.cer` or `.pem` with PEM format which the content starts with `----- BEGIN CERTIFICATE -----`
certFilename	string (JSON only) filename of client authentication certificate
httpEnable	boolean
httpPort	integer listen port for http
httpsEnable	boolean
httpsPort	integer listen port for https
key	string (JSON only) key content
keyFile	string <binary> (form-data only) key for https. The suffix of filename must be one of `.key`, `.pk` or `.pem` with PEM format which the content starts with `----- BEGIN RSA PRIVATE KEY -----`
keyFilename	string (JSON only) filename of client authentication key

Responses

Response samples

200

Content type

application/json

{"data": {"certFileName": "default.crt",
"httpEnable": true,
"httpPort": 80,
"httpsEnable": true,
"httpsPort": 443,
"keyFileName": "default.key"
}
}

Get provisioning service status

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"enable": true,
"schedule": {"enable": true,
"disableAfterSec": 900
}
}
}

Set provisioning service configuration

Authorizations:

bearerAuth

Request Body schema: application/json

enable	boolean enable provisioning function
	object

Responses

Request samples

Payload

Content type

application/json

{"enable": true,
"schedule": {"enable": true,
"disableAfterSec": 900
}
}

Response samples

200

Content type

application/json

{"data": {"enable": true,
"schedule": {"enable": true,
"disableAfterSec": 900
}
}
}

Get configuration or download log

Authorizations:

bearerAuth

query Parameters

download

boolean

Indicate to download log as zip file. Value is always true.

Responses

Response samples

200

Content type

application/json

{"data": {"desiredDiskCacheSizeMB": 100,
"disks": [{"device": "/dev/root",
"free": 3961389056,
"mount": "/",
"name": "System",
"percent": 27.531145236535952,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 5731123200,
"used": 1504944128
},
{"device": "/dev/mmcblk0p1",
"free": 1069535232,
"mount": "/host/media/sd-mmcblk0p1",
"name": "SD 1-1",
"percent": 75.04916265816615,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 4286570496,
"used": 3217035264
},
{"device": "/dev/mmcblk0p2",
"free": 4286566400,
"mount": "/host/media/mylabel",
"name": "mylabel",
"percent": 0.00009555424327728121,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 4286570496,
"used": 4096
},
{"device": "/dev/mmcblk0p3",
"free": 4286566400,
"mount": "/host/media/sd-mmcblk0p3",
"name": "SD 1-3",
"percent": 0.00009555424327728121,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 4286570496,
"used": 4096
}
],
"enable": true,
"enableTimeToLiveSec": false,
"targetDiskName": "System",
"timeToLiveSec": 86400
}
}

Set log configuration

Authorizations:

bearerAuth

Request Body schema: application/json

desiredDiskCacheSizeMB	string
disk	any refer to API `/device/general`
enable	boolean
enableTimeToLiveSec	boolean
targetDiskName	string
timeToLiveSec	integer unlimit if value <= 0

Responses

Request samples

Payload

Content type

application/json

{"desiredDiskCacheSizeMB": 100,
"enable": true,
"enableTimeToLiveSec": false,
"targetDiskName": "System",
"timeToLiveSec": 7200
}

Response samples

200

Content type

application/json

{"data": {"desiredDiskCacheSizeMB": 100,
"disks": [{"device": "/dev/root",
"free": 3961389056,
"mount": "/",
"name": "System",
"percent": 27.531145236535952,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 5731123200,
"used": 1504944128
},
{"device": "/dev/mmcblk0p1",
"free": 1069535232,
"mount": "/host/media/sd-mmcblk0p1",
"name": "SD 1-1",
"percent": 75.04916265816615,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 4286570496,
"used": 3217035264
},
{"device": "/dev/mmcblk0p2",
"free": 4286566400,
"mount": "/host/media/mylabel",
"name": "mylabel",
"percent": 0.00009555424327728121,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 4286570496,
"used": 4096
},
{"device": "/dev/mmcblk0p3",
"free": 4286566400,
"mount": "/host/media/sd-mmcblk0p3",
"name": "SD 1-3",
"percent": 0.00009555424327728121,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 4286570496,
"used": 4096
}
],
"enable": true,
"enableTimeToLiveSec": false,
"targetDiskName": "System",
"timeToLiveSec": 86400
}
}

Get reboot configuration

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"at": {"day": "1",
"dayOfWeek": "*",
"hour": "12",
"minute": "0",
"month": "1"
},
"enableScheduler": true,
"lastBootAt": "2019-01-01T12:00:00Z",
"nextTriggerAt": "2019-01-01T12:00:00Z"
}
}

Reboot system

Authorizations:

bearerAuth

Request Body schema: application/json

at	string the format can be a fixed string "now", datetime in RFC3339, or crontab (https://linux.die.net/man/5/crontab)
enableScheduler	boolean
now	boolean reboot immediately

Responses

Request samples

Payload

Content type

application/json

Example

now

{"now": true
}

Response samples

200

Content type

application/json

{"data": {"at": {"day": "1",
"dayOfWeek": "*",
"hour": "12",
"minute": "0",
"month": "1"
},
"enableScheduler": true,
"lastBootAt": "2019-01-01T12:00:00Z",
"nextTriggerAt": "2019-01-01T12:00:00Z"
}
}

get reset system capabilities

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"factory": {"isSupported": true,
"scopes": ["all"
]
},
"system": {"isSupported": true,
"scopes": ["all",
"account",
"appdata",
"discovery",
"eventlog",
"httpserver",
"job",
"journald",
"keep-network-setting",
"provision",
"reboot",
"sshserver",
"serialconsole",
"upgrade"
]
}
}
}

reset system to default configuration

Authorizations:

bearerAuth

query Parameters

mode	string Default: "system" Enum: "factory" "system"
sync	boolean Default: false If true, do reset immediately, else wait 3 seconds
scopes	Array of strings Items Enum: "all" "account" "appdata" "discovery" "eventlog" "httpserver" "job" "journald" "keep-network-setting" "provision" "reboot" "sshserver" "serialconsole" "upgrade" reset scope

Responses

Get serial console status

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"enable": true
}
}

Set serial console configuration

Authorizations:

bearerAuth

Request Body schema: application/json

enable

boolean

enable serial console

Responses

Request samples

Payload

Content type

application/json

{"enable": true
}

Response samples

200

Content type

application/json

{"data": {"enable": true
}
}

Get system services

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"cloudConnectivity": [{"available": true,
"enable": true,
"id": "cloud"
}
],
"network": [{"available": true,
"enable": true,
"id": "wifi"
},
{"available": true,
"enable": true,
"id": "cellular"
},
{"available": true,
"enable": true,
"id": "lan1"
},
{"available": true,
"enable": true,
"id": "lan2"
},
{"available": false,
"enable": false,
"id": "dhcpserver1"
},
{"available": true,
"enable": false,
"id": "dhcpserver2"
}
],
"protocol": [{"available": true,
"enable": true,
"id": "modbusmaster"
},
{"available": true,
"enable": true,
"id": "eipscanner"
},
{"available": true,
"enable": true,
"id": "opcuaserver"
}
],
"provisionService": [{"available": true,
"enable": true,
"id": "provision"
},
{"available": true,
"enable": true,
"id": "provisionschedule"
}
],
"service": [{"available": true,
"enable": false,
"id": "httpservice"
},
{"available": true,
"enable": true,
"id": "httpsservice"
},
{"available": true,
"enable": true,
"id": "ntp"
},
{"available": true,
"enable": true,
"id": "sshserver"
},
{"available": true,
"enable": true,
"id": "localconsole"
},
{"available": true,
"enable": false,
"id": "sdcard"
},
{"available": true,
"enable": true,
"id": "syslog"
},
{"available": true,
"enable": true,
"id": "eventlog"
}
]
}
}

Disable system service

Authorizations:

bearerAuth

path Parameters

id

required

string

Enum: "dhcpserver1" "dhcpserver2" "httpservice" "httpsservice" "sshserver" "localconsole" "lan1" "lan2" "cloud" "modbusmaster" "eipscanner" "opcuaserver" "sdcard" "ntp" "eventlog" "syslog" "wifi" "cellular" "provision" "provisionschedule"

service name

Responses

Response samples

200

Content type

application/json

{"data": {"enable": false
}
}

Enable system service

enable system services including Web GUI edge-web, DHCP Server dhcpserverX, Discovery discovery, HTTP service httpservice and so on.

Authorizations:

bearerAuth

path Parameters

id

required

string

Enum: "dhcpserver1" "dhcpserver2" "httpservice" "httpsservice" "sshserver" "localconsole" "lan1" "lan2" "cloud" "modbusmaster" "eipscanner" "opcuaserver" "sdcard" "ntp" "eventlog" "syslog" "wifi" "cellular" "provision" "provisionschedule"

service name

Responses

Response samples

200

Content type

application/json

{"data": {"enable": true
}
}

Get SSH configuration

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"enable": true,
"port": 22
}
}

Set SSH configuration

Authorizations:

bearerAuth

Request Body schema: application/json

enable	boolean enable SSH
port	integer port to listen

Responses

Request samples

Payload

Content type

application/json

{"enable": true,
"port": 22
}

Response samples

200

Content type

application/json

{"data": {"enable": true,
"port": 22
}
}

users

Query permissions

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"count": 2,
"data": [{"description": "",
"id": "SYS_USER_RW",
"name": "User/Role Management"
},
{"description": "",
"id": "SYS_MAINTENANCE_RW",
"name": "Device Management"
}
]
}

Query roles

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"count": 1,
"data": [{"description": "",
"id": 1,
"name": "Administrator",
"permissions": ["SYS_USER_RW",
"SYS_MAINTENANCE_RW"
],
"users": [{"id": 1,
"name": "admin"
},
{"id": 2,
"name": "myuser"
}
]
}
]
}

create a role

Authorizations:

bearerAuth

Request Body schema: application/json

description	string
name required	string
permissions required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"description": "",
"name": "myrole",
"permissions": ["SYS_USER_RW"
]
}

Response samples

200

Content type

application/json

{"data": {"description": "moxa best",
"id": 2,
"name": "myrole",
"permissions": ["SYS_USER_RW"
],
"users": [ ]
}
}

Delete role by ID

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of role

Responses

get role by ID

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of role

Responses

Response samples

200

Content type

application/json

{"data": {"description": "moxa best",
"id": 2,
"name": "myrole",
"permissions": ["SYS_USER_RW"
],
"users": [ ]
}
}

update role by ID

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of role

Request Body schema: application/json

description	string
name required	string
permissions required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"description": "",
"name": "myrole",
"permissions": ["SYS_USER_RW"
]
}

Response samples

200

Content type

application/json

{"data": {"description": "moxa best",
"id": 2,
"name": "myrole",
"permissions": ["SYS_USER_RW"
],
"users": [ ]
}
}

Query users

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"count": 1,
"data": [{"changedPasswordAt": null,
"createdAt": "2019-09-24T05:52:28.912234779Z",
"email": null,
"expiredAfter": null,
"id": 1,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "admin",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
]
}

Add user

Authorizations:

bearerAuth

Request Body schema: application/json

email	string
expiredAfter required	string <date-time>
isActive required	boolean
name required	string
password required	string at least 6 characters
roles required	Array of integers[ items ]

Responses

Request samples

Payload

Content type

application/json

{"expiredAfter": "2023-01-31T16:00:00.000Z",
"isActive": true,
"name": "myuser",
"password": "moxa1234",
"roles": [{"id": 1
}
]
}

Response samples

200

Content type

application/json

{"data": {"changedPasswordAt": null,
"createdAt": "2019-09-24T05:52:28.912234779Z",
"email": null,
"expiredAfter": null,
"id": 3,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "myuser",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
}

Delete user by ID

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of user

Responses

Query user by ID

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of user

Responses

Response samples

200

Content type

application/json

{"data": {"changedPasswordAt": null,
"createdAt": "2019-09-24T05:52:28.912234779Z",
"email": null,
"expiredAfter": null,
"id": 3,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "myuser",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
}

Update user by ID

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of user

Request Body schema: application/json

email	string
expiredAfter	string <date-time>
isActive	boolean
roles	Array of integers[ items ]

Responses

Request samples

Payload

Content type

application/json

{"email": "aa@aaa.aaa",
"expiredAfter": null,
"isActive": true,
"roles": [{"id": 1
}
]
}

Response samples

200

Content type

application/json

{"data": {"changedPasswordAt": null,
"createdAt": "2019-09-24T05:52:28.912234779Z",
"email": null,
"expiredAfter": null,
"id": 3,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "myuser",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
}

Update user's password by ID

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of user

Request Body schema: application/json

newPassword	string
oldPassword	string user with admin role do not need pass oldPassword

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "123456"
}

Response samples

200

Content type

application/json

{"data": {"changedPasswordAt": null,
"createdAt": "2019-09-24T05:52:28.912234779Z",
"email": null,
"expiredAfter": null,
"id": 3,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "myuser",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
}

Query who I am

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"changedPasswordAt": null,
"createdAt": "2019-09-24T05:52:28.912234779Z",
"email": null,
"expiredAfter": null,
"id": 3,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "myuser",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"remindToChangePassword": null,
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
}

Update current user's information

Authorizations:

bearerAuth

Request Body schema: application/json

email	string
expiredAfter	string
isActive	boolean
roles	Array of integers[ items ]

Responses

Request samples

Payload

Content type

application/json

{"email": "aa@aaa.aaa",
"expiredAfter": "2023-01-31T16:00:00.000Z",
"isActive": true,
"roles": [{"id": 1
}
]
}

Response samples

200

Content type

application/json

{"data": {"changedPasswordAt": null,
"createdAt": "2019-09-24T05:52:28.912234779Z",
"email": null,
"expiredAfter": null,
"id": 3,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "myuser",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
}

Update current user's password

Authorizations:

bearerAuth

Request Body schema: application/json

newPassword	string
oldPassword	string user with admin role do not need pass oldPassword

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "123456",
"oldPassword": "moxa1234"
}

Response samples

200

Content type

application/json

{"data": {"changedPasswordAt": null,
"createdAt": "2019-09-24T05:52:28.912234779Z",
"email": null,
"expiredAfter": null,
"id": 3,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "myuser",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
}

authentication

Get authentication status

This API returns wether authentication token in header is valid by HTTP status code

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": "ok"
}

Sign in

Request Body schema: application/json

name required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "admin",
"password": "moxa1234"
}

Response samples

200
401

Content type

application/json

{"data": {"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwicm9sZSI6InRlc3QiLCJpYXQiOjE1NjM0MjA5MTQsImV4cCI6NDcxNzAyMDkxNH0.7oGA1VHBingnzeG7hHgWEiZ4JmoserFguyeb7_GUK6E",
"user": {"changedPasswordAt": null,
"email": null,
"expiredAfter": null,
"id": 1,
"isActive": true,
"loginAt": "0001-01-01T00:00:00Z",
"name": "admin",
"permissions": ["SYS_MAINTENANCE_RW",
"SYS_USER_RW"
],
"roles": [{"id": 1,
"name": "Administrator"
}
]
}
}
}

Get websocket token

The token one-shot authentication for websocket only and valid in 30 seconds

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiUm9sZUlEIjoxLCJleHAiOjE1NjM2MTIxNjJ9.CaKmYYCyFXvWXZN0ZXO7dNk_9tBlhNaB9LIMX4bCujY"
}
}

event

Clear event logs

Authorizations:

bearerAuth

Responses

Get events

Authorizations:

bearerAuth

query Parameters

limit	integer Limit the number of result (default:100).
offset	integer Log starting from the offset (default:0).
order	string Enum: "time" "category" "eventName" Order by key (default:time).
sort	string Enum: "asc" "desc" sorting (default:desc).
categories	string Match by category which keywords seperated by comma(,)
eventNames	string Matcy by event name which keywords seperated by comma(,)
severities	string Filter out by severity which keywords seperated by comma(,)
origins	Array of strings Get the specified service of logs.
event	boolean Enable server-sent event (Value is always true if having this field).
download	boolean Download event as zip file (Value is always true if having this field).

Responses

Response samples

200

Content type

application/json

{"count": 2,
"data": [{"category": "system",
"createdAt": "2020-02-25T00:08:54.97510268+08:00",
"event": "software installation completed",
"id": 20340,
"message": "aaaaaaaaaaa bbbbbbbbbb ccccccccccc",
"origin": "system",
"severity": "info",
"user": "admin",
"userOrigin": "10.144.49.123"
},
{"category": "system",
"createdAt": "2020-02-25T00:08:54.92855576+08:00",
"event": "software installation completed",
"id": 20339,
"message": "aaaaaaaaaaa bbbbbbbbbb ccccccccccc",
"origin": "system",
"severity": "info",
"user": "admin",
"userOrigin": "10.144.49.123"
}
],
"limit": 2,
"offset": 0,
"total": 14154
}

Create log

Authorizations:

bearerAuth

Request Body schema: application/json

category required	string Event category
createdAt	string Event time in RFC3339 format (default:now).
event required	string Event message
message	string Event message in detail
origin required	string Which service/APP publish the event
severity	string Enum: "alert" "warning" "info" Event severity (default:info).
user	string Username who trigger the event
userOrigin	string User comes from. It's normally an IP address.

Responses

Request samples

Payload

Content type

application/json

{"category": "system",
"event": "software installation completed",
"message": "Installation completed. Job id: 1, software name: update-123",
"origin": "system",
"severity": "info"
}

Response samples

200

Content type

application/json

{"data": "ok"
}

Get configuration of events

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"desiredDiskCacheSizeMB": 2,
"disks": [{"device": "/dev/root",
"free": 1347792896,
"mount": "/",
"name": "System",
"percent": 75.34374779889012,
"protect": 838860800,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 5731123200,
"used": 4118540288
},
{"device": "/dev/mmcblk0p1",
"free": 7636680704,
"mount": "/media/sd-mmcblk0p1",
"name": "SD1-1",
"percent": 4.071308614330875,
"protect": 0,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 7960788992,
"used": 324108288
}
],
"enable": true,
"enableTimeToLiveSec": true,
"reachThresholdPolicy": "rotate",
"targetDiskName": "System",
"timeToLiveSec": 86400
}
}

Set event configuration

Authorizations:

bearerAuth

Request Body schema: application/json

desiredDiskCacheSizeMB	string
enable	boolean
enableTimeToLiveSec	boolean
reachThresholdPolicy	string Enum: "rotate" "stop" default to rotate
timeToLiveSec	integer unlimit if value <= 0

Responses

Request samples

Payload

Content type

application/json

{"desiredDiskCacheSizeMB": 2,
"enable": true,
"enableTimeToLiveSec": true,
"reachThresholdPolicy": "rotate",
"targetDiskName": "System",
"timeToLiveSec": 86400
}

Response samples

200

Content type

application/json

{"data": {"desiredDiskCacheSizeMB": 2,
"disks": [{"device": "/dev/root",
"free": 1347792896,
"mount": "/",
"name": "System",
"percent": 75.34374779889012,
"protect": 838860800,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 5731123200,
"used": 4118540288
},
{"device": "/dev/mmcblk0p1",
"free": 7636680704,
"mount": "/media/sd-mmcblk0p1",
"name": "SD1-1",
"percent": 4.071308614330875,
"protect": 0,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 7960788992,
"used": 324108288
}
],
"enable": true,
"enableTimeToLiveSec": true,
"reachThresholdPolicy": "rotate",
"targetDiskName": "System",
"timeToLiveSec": 86400
}
}

Event profile

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"categories": ["azure",
"device setting",
"modbus",
"mqtt",
"network",
"store-forward",
"system"
],
"eventNames": ["app crash",
"app start",
"app stop",
"buffer active",
"buffer clean",
"buffer full",
"buffer inactive",
"buffer sending",
"cellular no signal",
"cellular signal good",
"cellular signal low",
"configuration update failed",
"configuration update success",
"device connect",
"device connect fail",
"device connected",
"device connection fail",
"device disconnect",
"device reboot",
"device send properties fail",
"device send telemetry fail",
"edge connected",
"edge disconnected",
"edge send properties fail",
"edge send telemetry fail",
"function failed",
"function recover",
"master device conncted",
"master device disconnected",
"memory usage > 90%",
"ota download cancel",
"ota download completed",
"ota download failed",
"ota download resume",
"ota download suspend",
"slave device connected",
"slave device failed",
"software installation completed",
"software installation failed",
"system load 5 min > 1",
"system load 5 min > 3",
"system storage usage > 90%",
"system storage usage > 95%",
"time sync failed",
"time sync success",
"upgrade roll back completed",
"uplink change",
"user login fail",
"wrong function called"
],
"events": [{"category": "device setting",
"enable": true,
"event": "configuration update failed",
"id": 1,
"severity": "alert"
},
{"category": "device setting",
"enable": false,
"event": "configuration update success",
"id": 2,
"severity": "info"
},
{"category": "network",
"enable": true,
"event": "uplink change",
"id": 3,
"severity": "warning"
},
{"category": "device setting",
"enable": true,
"event": "time sync failed",
"id": 4,
"severity": "warning"
},
{"category": "device setting",
"enable": false,
"event": "time sync success",
"id": 5,
"severity": "info"
},
{"category": "network",
"enable": true,
"event": "cellular no signal",
"id": 6,
"severity": "alert"
},
{"category": "network",
"enable": true,
"event": "cellular signal low",
"id": 7,
"severity": "warning"
},
{"category": "network",
"enable": false,
"event": "cellular signal good",
"id": 8,
"severity": "info"
},
{"category": "system",
"enable": true,
"event": "system storage usage > 90%",
"id": 9,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "system storage usage > 95%",
"id": 10,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "system load 5 min > 1",
"id": 11,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "system load 5 min > 3",
"id": 12,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "memory usage > 90%",
"id": 13,
"severity": "warning"
},
{"category": "azure",
"enable": false,
"event": "edge connected",
"id": 14,
"severity": "info"
},
{"category": "azure",
"enable": true,
"event": "edge disconnected",
"id": 15,
"severity": "warning"
},
{"category": "azure",
"enable": true,
"event": "edge send properties fail",
"id": 16,
"severity": "alert"
},
{"category": "azure",
"enable": true,
"event": "edge send telemetry fail",
"id": 17,
"severity": "alert"
},
{"category": "azure",
"enable": false,
"event": "device connected",
"id": 18,
"severity": "info"
},
{"category": "azure",
"enable": true,
"event": "device disconnect",
"id": 19,
"severity": "warning"
},
{"category": "azure",
"enable": true,
"event": "device connection fail",
"id": 20,
"severity": "alert"
},
{"category": "azure",
"enable": true,
"event": "device send properties fail",
"id": 21,
"severity": "alert"
},
{"category": "azure",
"enable": true,
"event": "device send telemetry fail",
"id": 22,
"severity": "alert"
},
{"category": "store-forward",
"enable": true,
"event": "buffer active",
"id": 23,
"severity": "warning"
},
{"category": "store-forward",
"enable": false,
"event": "buffer inactive",
"id": 24,
"severity": "info"
},
{"category": "store-forward",
"enable": false,
"event": "buffer sending",
"id": 25,
"severity": "info"
},
{"category": "store-forward",
"enable": false,
"event": "buffer clean",
"id": 26,
"severity": "info"
},
{"category": "store-forward",
"enable": true,
"event": "buffer full",
"id": 27,
"severity": "alert"
},
{"category": "mqtt",
"enable": false,
"event": "device connect",
"id": 28,
"severity": "info"
},
{"category": "mqtt",
"enable": true,
"event": "device disconnect",
"id": 29,
"severity": "warning"
},
{"category": "mqtt",
"enable": true,
"event": "device connect fail",
"id": 30,
"severity": "alert"
},
{"category": "mqtt",
"enable": true,
"event": "device send telemetry fail",
"id": 31,
"severity": "alert"
},
{"category": "modbus",
"enable": true,
"event": "configuration update success",
"id": 37,
"severity": "warning"
},
{"category": "modbus",
"enable": true,
"event": "configuration update failed",
"id": 38,
"severity": "warning"
},
{"category": "modbus",
"enable": false,
"event": "slave device connected",
"id": 39,
"severity": "info"
},
{"category": "modbus",
"enable": true,
"event": "slave device failed",
"id": 40,
"severity": "alert"
},
{"category": "modbus",
"enable": false,
"event": "function recover",
"id": 41,
"severity": "info"
},
{"category": "modbus",
"enable": true,
"event": "function failed",
"id": 42,
"severity": "warning"
},
{"category": "modbus",
"enable": true,
"event": "master device conncted",
"id": 45,
"severity": "warning"
},
{"category": "modbus",
"enable": true,
"event": "master device disconnected",
"id": 46,
"severity": "warning"
},
{"category": "modbus",
"enable": true,
"event": "wrong function called",
"id": 47,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "device reboot",
"id": 48,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "user login fail",
"id": 49,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "app stop",
"id": 50,
"severity": "warning"
},
{"category": "system",
"enable": false,
"event": "app start",
"id": 51,
"severity": "info"
},
{"category": "system",
"enable": true,
"event": "app crash",
"id": 52,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "ota download failed",
"id": 53,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "ota download suspend",
"id": 54,
"severity": "warning"
},
{"category": "system",
"enable": false,
"event": "ota download resume",
"id": 55,
"severity": "info"
},
{"category": "system",
"enable": false,
"event": "ota download completed",
"id": 56,
"severity": "info"
},
{"category": "system",
"enable": true,
"event": "ota download cancel",
"id": 57,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "software installation failed",
"id": 58,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "upgrade roll back completed",
"id": 59,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "software installation completed",
"id": 60,
"severity": "info"
}
],
"origins": ["AID App",
"AIE App",
"Device App",
"MQTT Client",
"Modbus",
"system"
],
"severities": ["info",
"warning",
"alert"
]
}
}

Switch event enablement

Authorizations:

bearerAuth

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

Example

update by ID

{"events": [{"enable": true,
"id": 60
}
]
}

Response samples

200

Content type

application/json

{"data": {"categories": ["azure",
"device setting",
"modbus",
"mqtt",
"network",
"store-forward",
"system"
],
"eventNames": ["app crash",
"app start",
"app stop",
"buffer active",
"buffer clean",
"buffer full",
"buffer inactive",
"buffer sending",
"cellular no signal",
"cellular signal good",
"cellular signal low",
"configuration update failed",
"configuration update success",
"device connect",
"device connect fail",
"device connected",
"device connection fail",
"device disconnect",
"device reboot",
"device send properties fail",
"device send telemetry fail",
"edge connected",
"edge disconnected",
"edge send properties fail",
"edge send telemetry fail",
"function failed",
"function recover",
"master device conncted",
"master device disconnected",
"memory usage > 90%",
"ota download cancel",
"ota download completed",
"ota download failed",
"ota download resume",
"ota download suspend",
"slave device connected",
"slave device failed",
"software installation completed",
"software installation failed",
"system load 5 min > 1",
"system load 5 min > 3",
"system storage usage > 90%",
"system storage usage > 95%",
"time sync failed",
"time sync success",
"upgrade roll back completed",
"uplink change",
"user login fail",
"wrong function called"
],
"events": [{"category": "device setting",
"enable": true,
"event": "configuration update failed",
"id": 1,
"severity": "alert"
},
{"category": "device setting",
"enable": false,
"event": "configuration update success",
"id": 2,
"severity": "info"
},
{"category": "network",
"enable": true,
"event": "uplink change",
"id": 3,
"severity": "warning"
},
{"category": "device setting",
"enable": true,
"event": "time sync failed",
"id": 4,
"severity": "warning"
},
{"category": "device setting",
"enable": false,
"event": "time sync success",
"id": 5,
"severity": "info"
},
{"category": "network",
"enable": true,
"event": "cellular no signal",
"id": 6,
"severity": "alert"
},
{"category": "network",
"enable": true,
"event": "cellular signal low",
"id": 7,
"severity": "warning"
},
{"category": "network",
"enable": false,
"event": "cellular signal good",
"id": 8,
"severity": "info"
},
{"category": "system",
"enable": true,
"event": "system storage usage > 90%",
"id": 9,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "system storage usage > 95%",
"id": 10,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "system load 5 min > 1",
"id": 11,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "system load 5 min > 3",
"id": 12,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "memory usage > 90%",
"id": 13,
"severity": "warning"
},
{"category": "azure",
"enable": false,
"event": "edge connected",
"id": 14,
"severity": "info"
},
{"category": "azure",
"enable": true,
"event": "edge disconnected",
"id": 15,
"severity": "warning"
},
{"category": "azure",
"enable": true,
"event": "edge send properties fail",
"id": 16,
"severity": "alert"
},
{"category": "azure",
"enable": true,
"event": "edge send telemetry fail",
"id": 17,
"severity": "alert"
},
{"category": "azure",
"enable": false,
"event": "device connected",
"id": 18,
"severity": "info"
},
{"category": "azure",
"enable": true,
"event": "device disconnect",
"id": 19,
"severity": "warning"
},
{"category": "azure",
"enable": true,
"event": "device connection fail",
"id": 20,
"severity": "alert"
},
{"category": "azure",
"enable": true,
"event": "device send properties fail",
"id": 21,
"severity": "alert"
},
{"category": "azure",
"enable": true,
"event": "device send telemetry fail",
"id": 22,
"severity": "alert"
},
{"category": "store-forward",
"enable": true,
"event": "buffer active",
"id": 23,
"severity": "warning"
},
{"category": "store-forward",
"enable": false,
"event": "buffer inactive",
"id": 24,
"severity": "info"
},
{"category": "store-forward",
"enable": false,
"event": "buffer sending",
"id": 25,
"severity": "info"
},
{"category": "store-forward",
"enable": false,
"event": "buffer clean",
"id": 26,
"severity": "info"
},
{"category": "store-forward",
"enable": true,
"event": "buffer full",
"id": 27,
"severity": "alert"
},
{"category": "mqtt",
"enable": false,
"event": "device connect",
"id": 28,
"severity": "info"
},
{"category": "mqtt",
"enable": true,
"event": "device disconnect",
"id": 29,
"severity": "warning"
},
{"category": "mqtt",
"enable": true,
"event": "device connect fail",
"id": 30,
"severity": "alert"
},
{"category": "mqtt",
"enable": true,
"event": "device send telemetry fail",
"id": 31,
"severity": "alert"
},
{"category": "modbus",
"enable": true,
"event": "configuration update success",
"id": 37,
"severity": "warning"
},
{"category": "modbus",
"enable": true,
"event": "configuration update failed",
"id": 38,
"severity": "warning"
},
{"category": "modbus",
"enable": false,
"event": "slave device connected",
"id": 39,
"severity": "info"
},
{"category": "modbus",
"enable": true,
"event": "slave device failed",
"id": 40,
"severity": "alert"
},
{"category": "modbus",
"enable": false,
"event": "function recover",
"id": 41,
"severity": "info"
},
{"category": "modbus",
"enable": true,
"event": "function failed",
"id": 42,
"severity": "warning"
},
{"category": "modbus",
"enable": true,
"event": "master device conncted",
"id": 45,
"severity": "warning"
},
{"category": "modbus",
"enable": true,
"event": "master device disconnected",
"id": 46,
"severity": "warning"
},
{"category": "modbus",
"enable": true,
"event": "wrong function called",
"id": 47,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "device reboot",
"id": 48,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "user login fail",
"id": 49,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "app stop",
"id": 50,
"severity": "warning"
},
{"category": "system",
"enable": false,
"event": "app start",
"id": 51,
"severity": "info"
},
{"category": "system",
"enable": true,
"event": "app crash",
"id": 52,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "ota download failed",
"id": 53,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "ota download suspend",
"id": 54,
"severity": "warning"
},
{"category": "system",
"enable": false,
"event": "ota download resume",
"id": 55,
"severity": "info"
},
{"category": "system",
"enable": false,
"event": "ota download completed",
"id": 56,
"severity": "info"
},
{"category": "system",
"enable": true,
"event": "ota download cancel",
"id": 57,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "software installation failed",
"id": 58,
"severity": "alert"
},
{"category": "system",
"enable": true,
"event": "upgrade roll back completed",
"id": 59,
"severity": "warning"
},
{"category": "system",
"enable": true,
"event": "software installation completed",
"id": 60,
"severity": "info"
}
],
"origins": ["AID App",
"AIE App",
"Device App",
"MQTT Client",
"Modbus",
"system"
],
"severities": ["info",
"warning",
"alert"
]
}
}

apps

Return all APPs

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"count": 5,
"data": [{"arch": "armhf",
"attributes": ["started",
"installed"
],
"availableVersions": [ ],
"category": "device",
"description": "MOXA hardware service",
"desiredState": "ready",
"displayName": "Device",
"hardwares": [ ],
"health": "wait",
"icon": "/app-icons/device.png",
"id": "device",
"imageSize": 86970368,
"license": {"paid": false,
"type": "propetual"
},
"menuID": "app-device",
"name": "device",
"state": "starting",
"version": "1.0.0-284-uc-8112a-me"
},
{"arch": "armhf",
"attributes": ["started",
"installed"
],
"availableVersions": [ ],
"category": "cloud",
"description": "Azure IoT Edge",
"desiredState": "ready",
"displayName": "Azure IoT Edge",
"hardwares": [ ],
"health": "wait",
"icon": "",
"id": "aie",
"imageSize": 71293440,
"license": {"paid": true,
"type": "free"
},
"menuID": "app-aie",
"name": "aie",
"state": "starting",
"version": "0.3.1-52"
},
{"arch": "armhf",
"attributes": ["openInSameTab"
],
"availableVersions": [ ],
"category": "protocol",
"description": "MOXA Modbus TCP Client (Master)",
"desiredState": "ready",
"displayName": "Modbus TCP Client (Master)",
"hardwares": [ ],
"health": "wait",
"icon": "/app-icons/modbusmaster-tcp.png",
"id": "modbusmaster-tcp",
"imageSize": 61130240,
"license": {"paid": true,
"type": "free"
},
"menuID": "app-modbusmaster-tcp",
"name": "modbusmaster-tcp",
"state": "starting",
"version": "3.14.0-278"
},
{"arch": "armhf",
"attributes": ["installed",
"started",
"hide"
],
"availableVersions": [ ],
"category": "intelligence",
"description": "ThingsPro frontend web application\n",
"desiredState": "ready",
"displayName": "ThingsPro Edge Web",
"hardwares": [ ],
"health": "good",
"icon": "",
"id": "edge-web",
"imageSize": 0,
"license": {"paid": true,
"type": "free"
},
"menuID": "app-edge-web",
"name": "edge-web",
"state": "ready",
"version": "0.28.0-322"
},
{"arch": "armhf",
"attributes": ["installed",
"started",
"openInSameTab"
],
"availableVersions": [ ],
"category": "intelligence",
"description": "ThingsPro Tag Framework Core\n",
"desiredState": "ready",
"displayName": "Tag Service",
"hardwares": [ ],
"health": "running",
"icon": "",
"id": "tagservice",
"imageSize": 84914688,
"license": {"paid": true,
"type": "free"
},
"menuID": "app-tagservice",
"name": "tagservice",
"state": "starting",
"version": "1.5.0-168"
}
]
}

Find APP by name

Authorizations:

bearerAuth

path Parameters

appname

required

string

name of APP

Responses

Response samples

200

Content type

application/json

{"data": {"arch": "armhf",
"attributes": ["installed",
"started",
"openInSameTab"
],
"availableVersions": [ ],
"category": "intelligence",
"description": "ThingsPro Tag Framework Core\n",
"desiredState": "ready",
"displayName": "Tag Service",
"hardwares": [ ],
"health": "good",
"icon": "",
"id": "tagservice",
"imageSize": 84914688,
"license": {"paid": true,
"type": "free"
},
"name": "tagservice",
"state": "ready",
"version": "1.5.0-168"
}
}

Operate an APP

Authorizations:

bearerAuth

path Parameters

appname required	string name of APP
action required	string Enum: "start" "stop" "install" "uninstall" "restart"

Responses

Response samples

200

Content type

application/json

{"data": {"arch": "armhf",
"attributes": ["installed",
"started",
"openInSameTab"
],
"availableVersions": [ ],
"category": "intelligence",
"description": "ThingsPro Tag Framework Core\n",
"desiredState": "ready",
"displayName": "Tag Service",
"hardwares": [ ],
"health": "good",
"icon": "",
"id": "tagservice",
"imageSize": 84914688,
"license": {"paid": true,
"type": "free"
},
"name": "tagservice",
"state": "ready",
"version": "1.5.0-168"
}
}

job

Get jobs

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"count": 1,
"data": [{"at": null,
"completedAt": null,
"createdAt": "2019-10-31T14:05:48.287613208+08:00",
"id": 6,
"lastState": "",
"nextTriggerAt": null,
"now": true,
"owner": "system",
"pendingAt": "2019-10-31T14:05:48.464809333+08:00",
"resourceID": 4,
"resourceType": "installation",
"startedAt": "2019-10-31T14:05:48.481181202+08:00",
"state": "running"
}
]
}

upgrade

Get upgrade configuration

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": {"allowOverCellular": true,
"caName": "ca.crt",
"certFileName": "client.crt",
"disks": [{"device": "/dev/root",
"free": 2856562688,
"mount": "/",
"name": "System",
"percent": 47.74261663447114,
"protect": 838860800,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 5731123200,
"used": 2609770496
},
{"device": "/dev/mmcblk0p1",
"free": 7423197184,
"mount": "/media/sd-mmcblk0p1",
"name": "SD1-1",
"percent": 6.752996575342466,
"protect": 0,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 7960788992,
"used": 537591808
}
],
"enableClientAuth": false,
"enableSnapshot": false,
"isSnapshotSupported": true,
"keyFileName": "client.key",
"retryCount": 3,
"retryInterval": 5,
"targetDiskName": "SD1-1"
}
}

Set upgrade configuration partially

Authorizations:

bearerAuth

Request Body schema: application/json

allowOverCellular	boolean allow upgrade over the cellular
disks	Array of objects[ items ] disk list
enableClientAuth	boolean use cert and key as X.509 client authentication
enableSnapshot	boolean do snapshot during upgrade. If the device doesn’t support snapshot feature (isSnapshotSupported), the request will be rejected with an error.
isSnapshotSupported	boolean whether supports snapshot
retryCount	integer maximum re-try count to download upgrade package. 0 means unlimited.
retryInterval	integer re-try interval in seconds to download upgrade package.
targetDiskName	string disk partition name to store upgrade file

Responses

Request samples

Payload

Content type

application/json

{"allowOverCellular": true,
"disks": [{ }
],
"enableClientAuth": true,
"enableSnapshot": true,
"isSnapshotSupported": true,
"retryCount": 0,
"retryInterval": 0,
"targetDiskName": "string"
}

Response samples

200

Content type

application/json

{"data": {"allowOverCellular": true,
"caName": "ca.crt",
"certFileName": "client.crt",
"disks": [{"device": "/dev/root",
"free": 2856562688,
"mount": "/",
"name": "System",
"percent": 47.74261663447114,
"protect": 838860800,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 5731123200,
"used": 2609770496
},
{"device": "/dev/mmcblk0p1",
"free": 7423197184,
"mount": "/media/sd-mmcblk0p1",
"name": "SD1-1",
"percent": 6.752996575342466,
"protect": 0,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 7960788992,
"used": 537591808
}
],
"enableClientAuth": false,
"enableSnapshot": false,
"isSnapshotSupported": true,
"keyFileName": "client.key",
"retryCount": 3,
"retryInterval": 5,
"targetDiskName": "SD1-1"
}
}

Set upgrade configuration

Authorizations:

bearerAuth

Request Body schema:
application/json

allowOverCellular	boolean allow upgrade over the cellular
ca	string CA content
caFilename	string filename of CA
cert	string certificate content
certFilename	string filename of client authentication certificate
disks	Array of objects[ items ] disk list
enableClientAuth	boolean use cert and key as X.509 client authentication
enableSnapshot	boolean do snapshot during upgrade. If the device doesn’t support snapshot feature (isSnapshotSupported), the request will be rejected with an error.
isSnapshotSupported	boolean whether supports snapshot
key	string key content
keyFilename	string filename of client authentication key
retryCount	integer maximum re-try count to download upgrade package. 0 means unlimited.
retryInterval	integer re-try interval in seconds to download upgrade package.
targetDiskName	string partition to store upgrade file

Responses

Request samples

Payload

Content type

application/json

{"allowOverCellular": true,
"ca": "xxxxxx",
"caFilename": "ca.crt",
"cert": "xxxxxxx",
"certFilename": "a.crt",
"enableClientAuth": true,
"enableSnapshot": true,
"key": "xxxxx",
"keyFilename": "a.key",
"retryCount": 3,
"retryInterval": 0,
"targetDiskName": "System"
}

Response samples

200

Content type

application/json

{"data": {"allowOverCellular": true,
"caName": "ca.crt",
"certFileName": "client.crt",
"disks": [{"device": "/dev/root",
"free": 2856562688,
"mount": "/",
"name": "System",
"percent": 47.74261663447114,
"protect": 838860800,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 5731123200,
"used": 2609770496
},
{"device": "/dev/mmcblk0p1",
"free": 7423197184,
"mount": "/media/sd-mmcblk0p1",
"name": "SD1-1",
"percent": 6.752996575342466,
"protect": 0,
"tags": {"free": "systemDiskFree",
"percent": "systemDiskPercent",
"used": "systemDiskUsed"
},
"total": 7960788992,
"used": 537591808
}
],
"enableClientAuth": false,
"enableSnapshot": false,
"isSnapshotSupported": true,
"keyFileName": "client.key",
"retryCount": 3,
"retryInterval": 5,
"targetDiskName": "SD1-1"
}
}

Retrieve all upgrade jobs

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"count": 2,
"data": [{"completedAt": null,
"completedTask": 0,
"createdAt": "2020-02-24T10:59:11.63206964+08:00",
"id": 1,
"isDeleted": false,
"lastState": "",
"owner": "system",
"parameter": {"at": null,
"deleteFileAfterInstallComplete": true,
"download": true,
"id": null,
"install": false,
"snapshot": true,
"url": "http://10.144.48.106:10080/moxaics/v3/edge/builds/edge-core-update/develop/1106/update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb"
},
"pendingAt": null,
"startedAt": null,
"state": "created",
"tasks": [{"completedAt": null,
"id": 1,
"name": "update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb",
"progress": 0,
"startedAt": null,
"state": "created",
"totalSize": 213375528,
"type": "download"
}
],
"totalTask": 1,
"triggerdAt": null
},
{"completedAt": null,
"completedTask": 0,
"createdAt": "2020-02-24T10:59:14.67798968+08:00",
"id": 2,
"isDeleted": false,
"lastState": "",
"owner": "system",
"parameter": {"at": null,
"deleteFileAfterInstallComplete": true,
"download": true,
"id": null,
"install": false,
"snapshot": true,
"url": "http://10.144.48.106:10080/moxaics/v3/edge/builds/edge-core-update/develop/1106/update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb"
},
"pendingAt": null,
"startedAt": null,
"state": "created",
"tasks": [{"completedAt": null,
"id": 2,
"name": "update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb",
"progress": 0,
"startedAt": null,
"state": "created",
"totalSize": 213375528,
"type": "download"
}
],
"totalTask": 1,
"triggerdAt": null
}
]
}

Create upgrade job

Authorizations:

bearerAuth

Request Body schema:
application/json

	object Run the job periodically
deleteFileAfterInstallComplete	boolean Delete installation file after upgrade completed (default:true)
download	boolean Indicate to request download
file	string (form-data) file for Debian package
id	integer Upgrade ID
install	boolean Indicate to request install
snapshot	boolean Do snapshot when installation. If not set, it will apply by default configuration of `/system/upgrade`.
url	string URL to download

Responses

Request samples

Payload

Content type

application/json

Example

download and install immediately

{"deleteFileAfterInstallComplete": true,
"install": true,
"url": "https://mxswdc2.s3-ap-northeast-1.amazonaws.com/v3/edge/builds/edge-core-update/release/iotedge/v1.1.0/275/package_1.1.0-275-uc-8112a-me_armhf.yaml"
}

Response samples

200

Content type

application/json

{"data": {"completedAt": null,
"completedTask": 0,
"createdAt": "2020-02-24T10:57:38.28929348+08:00",
"id": 12,
"isDeleted": false,
"lastState": "",
"owner": "system",
"parameter": {"at": null,
"deleteFileAfterInstallComplete": true,
"download": true,
"id": null,
"install": false,
"snapshot": true,
"url": "http://10.144.48.106:10080/moxaics/v3/edge/builds/edge-core-update/develop/1106/update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb"
},
"pendingAt": null,
"startedAt": null,
"state": "created",
"tasks": [{"completedAt": null,
"id": 57,
"name": "update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb",
"progress": 0,
"startedAt": null,
"state": "created",
"totalSize": 213375528,
"type": "download"
}
],
"totalTask": 1,
"triggerdAt": null
}
}

Delete upgrade job

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of upgrade job

Responses

Find upgrade job by ID

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID of upgrade job

Responses

Response samples

200

Content type

application/json

Example

canceled job

{"data": {"completedAt": "2020-02-24T10:54:27.16629856+08:00",
"completedTask": 0,
"createdAt": "2020-02-24T10:51:17.57571124+08:00",
"id": 9,
"isDeleted": false,
"lastState": "running",
"owner": "system",
"parameter": {"at": null,
"deleteFileAfterInstallComplete": true,
"download": true,
"id": null,
"install": false,
"snapshot": true,
"url": "http://10.144.48.106:10080/moxaics/v3/edge/builds/edge-core-update/develop/1106/update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb"
},
"pendingAt": "2020-02-24T10:51:23.4746076+08:00",
"startedAt": "2020-02-24T10:51:23.50617604+08:00",
"state": "canceled",
"tasks": [{"completedAt": "2020-02-24T10:54:27.05335256+08:00",
"id": 54,
"name": "update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb",
"progress": 2,
"speed": 3670,
"startedAt": "2020-02-24T10:51:23.57414428+08:00",
"state": "canceled",
"totalSize": 213375528,
"type": "download"
}
],
"totalTask": 1,
"triggerdAt": null
}
}

Operate the upgrade

Authorizations:

bearerAuth

path Parameters

id required	integer id of upgrade pack
action required	string Enum: "start" "cancel" "suspend" "resume" id of upgrade pack
deleteFileAfterInstallComplete required	boolean Delete upgrade file after upgrade completed (default:true)

Responses

Response samples

200

Content type

application/json

{"data": {"completedAt": "2020-02-24T11:00:28.75763008+08:00",
"completedTask": 0,
"createdAt": "2020-02-24T10:59:11.63206964+08:00",
"id": 1,
"isDeleted": false,
"lastState": "running",
"owner": "system",
"parameter": {"at": null,
"deleteFileAfterInstallComplete": true,
"download": true,
"id": null,
"install": false,
"snapshot": true,
"url": "http://10.144.48.106:10080/moxaics/v3/edge/builds/edge-core-update/develop/1106/update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb"
},
"pendingAt": "2020-02-24T11:00:12.61542208+08:00",
"startedAt": "2020-02-24T11:00:12.63342556+08:00",
"state": "canceled",
"tasks": [{"completedAt": "2020-02-24T11:00:28.72362264+08:00",
"id": 1,
"name": "update_2.0.0-1106-uc-8112a-me-iotedge_armhf.deb",
"progress": 0,
"startedAt": "2020-02-24T11:00:12.78006724+08:00",
"state": "canceled",
"totalSize": 213375528,
"type": "download"
}
],
"totalTask": 1,
"triggerdAt": null
}
}