REST APIs

All Platform Portal functionality is built on REST APIs that developers can call directly to access resources and control their devices programmatically.

Authentication

`GET` /auth/ping

Ping the server to see if it is still alive.

Response 200 OK
- Body
```
pong
```

`GET` /auth/agentinfo

Get the agent information. (since v1.8.1)

Response 200 OK

Request Successfully

Body

{
  &quot;version&quot;: &quot;v1.8.1&quot;
}

`GET` /auth/version

Get the API version. (since v1.7.1)

Response 200 OK

Request Successfully
- Body
```
{
  &quot;version&quot;:1.2
}
```

`GET` /auth/token{?m}

Get with the OS or the admin account and return the JWT token if the user is valid. A request contains a header field in the form of Authorization: Basic , where credentials are the Base64 encoding of username and password joined by a single colon : username:password => (base64) => dXNlcm5hbWU6cGFzc3dvcmQ=

(since v1.7.1, API version 1.1)

URI Parameters

m number (optional) - User account type. (since v1.8.1, API version 1.2)
- 0: OS account (default)
- 2: admin account (default password: p@ssw0rd, must be changed after login)
Request Header

Authorization: Basic

Response 200 OK

Body

{
  &quot;code&quot;: 200
  &quot;expire&quot;:&quot;20XX-XX-XXT14:08:33+08:00&quot;
  &quot;token&quot;: &quot;&quot;
}

Cookie (if available)

Secure and HttpOnly cookies
```
Key: jwt
Value: 
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`POST` /auth/login{?m}

URI Parameters

m number (optional) - User account type. (since 1.8.1, API version 1.2)
- 0: OS account (default)
- 2: admin account (default password: p@ssw0rd, must be changed after login)

Request body

{
  &quot;username&quot;: &quot;your_username&quot;,
  &quot;password&quot;: &quot;your_password&quot;
}

Response 200 OK

Body

{
  &quot;code&quot;: 200
  &quot;expire&quot;:&quot;20XX-XX-XXT14:08:33+08:00&quot;
  &quot;token&quot;: &quot;&quot;
}

Cookie (if available)

Secure and HttpOnly cookies
```
Key: jwt
Value: 
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`POST` /auth/logout

Log out and clear the cookie.

Response 200 OK
```
{
  &quot;code&quot;: 200
}
```

`GET` /auth/certificate

Download the JWT certificate file in the PEM format.

Response 200 OK

Headers

Content-Type: application/octet-stream
Content-Description: File Transfer
Content-Transfer-Encoding: Binary
Content-Disposition: attachment; filename=cert.pem.crt

`PUT` /auth/user/admin/password

Change the admin’s password. (since 1.8.1, API version 1.2)

Request Headers

Log in with the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

{
  &quot;old&quot;: &quot;&quot;,
  &quot;new&quot;: &quot;&quot;,
}

Response 200 OK

Response 400 Bad Request

{
    &quot;code&quot;: 400, // optional
    &quot;message&quot;: &quot;&quot;
}

Response 401 Unauthorized

{
    &quot;code&quot;: 401,
    &quot;message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied, but the request body is invalid.
```
{
    &quot;errors&quot;: {
        &quot;validator&quot;: &quot;&quot;
    }
}
```

`DELETE` /auth/user/admin/password

Reset the admin’s password to the default value (p@ssw0rd). (since 1.8.1, API version 1.2)

Request Headers

Log in with the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Response 400 Bad Request

{
    &quot;code&quot;: 400, // optional
    &quot;message&quot;: &quot;&quot;
}

Response 401 Unauthorized

{
    &quot;code&quot;: 401,
    &quot;message&quot;: &quot;&quot;
}

H/W Monitor

`GET` /platform/api/hwmon

Get all H/W Monitor data, including Temperature, Voltage, Current, and Fan Speed.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;temperature&quot;: [
    {
      &quot;name&quot;: &quot;CPU&quot;,
      &quot;value&quot;: &quot;50.1&quot;,
      &quot;unit&quot;: &quot;Celsius&quot;
    }
  ],
  "voltage": [
    {
      &quot;name&quot;: &quot;VCore&quot;,
      &quot;value&quot;: &quot;0.92&quot;,
      &quot;unit&quot;: &quot;Volt&quot;
    },
    {
      &quot;name&quot;: &quot;12V&quot;,
      &quot;value&quot;: &quot;11.86&quot;,
      &quot;unit&quot;: &quot;Volt&quot;
    }
  ],
  "current": [
    {
      &quot;name&quot;: &quot;OEM0&quot;,
      &quot;value&quot;: &quot;0.54&quot;,
      &quot;unit&quot;: &quot;A&quot;
    }
  ],
  "fanspeed": [
    {
      &quot;name&quot;: &quot;FAN0&quot;,
      &quot;value&quot;: &quot;1234&quot;,
      &quot;unit&quot;: &quot;RPM&quot;
    }
  ]
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404

Not supported or no available data.

`GET` /platform/api/hwmon (SSE)

Get all H/W Monitor data, including Temperature, Voltage, Current, and Fan Speed via Server-Sent Events (SSE).

EventStream

event: message
data: {&quot;current&quot;:[{&quot;name&quot;:&quot;OEM0&quot;,&quot;value&quot;:0.34,  &quot;unit&quot;:&quot;A&quot;}],"temperature":[{&quot;name&quot;:&quot;CPU&quot;,&quot;value&quot;:41,  &quot;unit&quot;:&quot;Celsius&quot;}],"voltage":[{&quot;name&quot;:&quot;Vcore&quot;,  &quot;value&quot;:0.92,&quot;unit&quot;:&quot;Volt&quot;},{&quot;name&quot;:&quot;12V&quot;,&quot;value&quot;:11.  86,&quot;unit&quot;:&quot;Volt&quot;},{&quot;name&quot;:&quot;5V Standby&quot;,&quot;value&quot;:4.95,  &quot;unit&quot;:&quot;Volt&quot;},{&quot;name&quot;:&quot;CMOS Battery&quot;,&quot;value&quot;:3.05,  &quot;unit&quot;:&quot;Volt&quot;}]}

`GET` /platform/api/hwmon/temperatures

Get H/W Monitor temperature data.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "name": "CPU", "value": 40, "unit": "Celsius" }, ... ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404

Not supported or no available data.

`GET` /platform/api/hwmon/voltages

Get H/W Monitor voltage data.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "name": "Vcore", "value": 0.92, "unit": "Volt" }, ... ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404

Not supported or no available data.

`GET` /platform/api/hwmon/currents

Get H/W Monitor current data.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "name": "OEM0", "value": 0.54, "unit": "A" }, ... ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

`GET` /platform/api/hwmon/fanspeeds

Get H/W Monitor fan speed data.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "name": "FAN0", "value": 1234, "unit": "RPM" }, ... ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Platform

`GET` /platform/api/ping

Ping the server to see if it is still alive.

Response 200 OK
- Body
```
pong
```

`GET` /platform/api/agentinfo

Get the agent information. (since v0.14.1)

Response 200 OK

Request Successfully

Body

{
  &quot;version&quot;: &quot;v0.14.1&quot;
}

Portal

`GET` /api/ping

Ping the portal-service server to see if it is still alive.

Response 200 OK
- Body
```
pong
```

`GET` /api/agentinfo

Get the portal-service agent information. (since v0.14.1)

Response 200 OK

Request Successfully

Body

{
  &quot;version&quot;: &quot;v0.14.1&quot;
}

`GET` /api/irtm/ping

Ping the iFactory RTM server to see if it is still alive.

Response 200 OK
- Body
```
pong
```

System Information

Host Information

`GET` /platform/api/host/info

Get host information, including BIOS information, Boot Count, Boot Time, Device Name (BIOS Name), OS Information, and Image Information (if available).

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;biosSerialNumber&quot;: &quot;Default string&quot;,
  &quot;biosUUID&quot;: &quot;03000200-0400-0500-0006-000700080009&quot;,
  &quot;biosVersion&quot;: &quot;N/A&quot;,
  &quot;bootCount&quot;: 22862,
  &quot;bootTime&quot;: 1619413851,
  &quot;deviceName&quot;: &quot;UNO-2484G-673xAE&quot;,
  &quot;dockerVersion&quot;: &quot;Docker version 19.03.13, build 4484c46d9d&quot;,
  &quot;ecVersion&quot;: &quot;0.5&quot;,
  &quot;hostid&quot;: &quot;d6d6752c-a6d4-4d02-96b1-96e2d3a8d2b2&quot;,
  &quot;hostname&quot;: &quot;UNO-2484G-673xA&quot;,
  &quot;imageVersion&quot;: &quot;6.04 Build 005&quot;,
  &quot;kernelArch&quot;: &quot;x86_64&quot;,
  &quot;os&quot;: &quot;windows&quot;,
  &quot;platform&quot;: &quot;Microsoft Windows 10 Enterprise LTSC 2019&quot;,
  &quot;releaseDate&quot;: &quot;01/23/2019&quot;,
  &quot;upTime&quot;: 851779
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`GET` /platform/api/host/display/count

Get available display count.

Prerequisite
- rest-server 0.12.1.0 and later
Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
1
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`GET` /platform/api/host/screenshot/:index

Get the specified display screenshot by index

Prerequisite
- rest-server 0.12.1.0 and later
Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;data&quot;: &quot;&quot;,
  &quot;mediaType&quot;: &quot;image/png&quot;
}

You can use Data URLs to render the response base64 encoded image.

data:[][;base64],

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Host&quot;: &quot;&quot;
    }
}

`GET` /platform/api/host/screenshot/:index/file

Get the specified display screenshot file by index

Prerequisite
- rest-server 0.12.1.0 and later
Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Returns the screenshot image file directly

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Host&quot;: &quot;&quot;
    }
}

System Performance

`GET` /platform/api/systemperf

Get CPU, Memory information, and usage.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;cpu&quot;: {
    &quot;info&quot;: {
      &quot;cpu&quot;: 0,
      &quot;vendorId&quot;: &quot;GenuineIntel&quot;,
      &quot;family&quot;: &quot;6&quot;,
      &quot;model&quot;: &quot;78&quot;,
      &quot;stepping&quot;: 3,
      &quot;physicalId&quot;: &quot;0&quot;,
      &quot;coreId&quot;: &quot;0&quot;,
      &quot;cores&quot;: 1,
      &quot;modelName&quot;: &quot;Intel(R) Core(TM) i7-6600U CPU @ 2.60GHz&quot;,
      &quot;mhz&quot;: 2600,
      &quot;cacheSize&quot;: 4096,
      &quot;flags&quot;: [
        &quot;sse&quot;,
        &quot;sse2&quot;,
        &quot;...&quot;
      ],
      &quot;microcode&quot;: &quot;0xc6&quot;
    },
    "usage": [
      0,
      0,
      0.9999999999990905,
      0
    ]
  },
  "memory": {
    &quot;total&quot;: 8265986048,
    &quot;available&quot;: 7532920832,
    &quot;used&quot;: 415899648,
    &quot;usedPercent&quot;: 5.031458383608441,
    &quot;free&quot;: 6488629248,
    &quot;...&quot;: ...
  }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`GET` /platform/api/systemperf/cpu

Get CPU information and usage.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;info&quot;: {
    &quot;cpu&quot;: 0,
    &quot;vendorId&quot;: &quot;GenuineIntel&quot;,
    &quot;family&quot;: &quot;6&quot;,
    &quot;model&quot;: &quot;78&quot;,
    &quot;stepping&quot;: 3,
    &quot;physicalId&quot;: &quot;0&quot;,
    &quot;coreId&quot;: &quot;0&quot;,
    &quot;cores&quot;: 1,
    &quot;modelName&quot;: &quot;Intel(R) Core(TM) i7-6600U CPU @ 2.60GHz&quot;,
    &quot;mhz&quot;: 2600,
    &quot;cacheSize&quot;: 4096,
    &quot;flags&quot;: [
        &quot;sse&quot;,
        &quot;sse2&quot;,
        &quot;...&quot;
    ],
    &quot;microcode&quot;: &quot;0xc6&quot;
  },
  "usage": [
    1.5625,
    0,
    1.5625,
    0
  ]
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`GET` /platform/api/systemperf/memory

Get memory information and usage.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;total&quot;: 8265986048,
  &quot;available&quot;: 7532576768,
  &quot;used&quot;: 417800192,
  &quot;usedPercent&quot;: 5.05445072824783,
  &quot;free&quot;: 6486446080,
  &quot;...&quot;: ...
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

System Devices

`GET` /platform/api/devmgr

Get a list of the hardware attached to the computer.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "class": "ACPI", "instancePath": "ACPI\PNP0000\4&15FBC11C&0", "name": "Programmable interrupt controller", "status": "stopped" }, { "class": "STORAGE", "instancePath": "STORAGE\VOLUME\{7963B29A-147B-11EB-92A9-806E6F6E6963}#000000002F900000", "name": "Volume", "status": "running" }, { "class": "STORAGE", "instancePath": "STORAGE\VOLUME\{7963B29A-147B-11EB-92A9-806E6F6E6963}#000000001F500000", "name": "Volume", "status": "running" }, { "class": "PCI", "instancePath": "PCI\VEN_8086&DEV_9D15&SUBSYS_72708086&REV_F1\3&11583659&0&E0", "name": "PCI-to-PCI Bridge", "vendorID": "8086", "deviceID": "9D15", "status": "running" }, { "class": "USB", "instancePath": "USB\VID_05E3&PID_0612\5&2C705BFE&0&15", "name": "Generic SuperSpeed USB Hub", "vendorID": "05E3", "deviceID": "0612", "status": "running" } ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;DevMgr&quot;: &quot;&quot;
    }
}

Service

(since rest-server 1.0.1)

`GET` /platform/api/service/list

Get the service list

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "name": "AppHubEdgeService", "displayName": "AppHub-Edge Service", "description": "", "status": "running" }, { "name": "ALG", "displayName": "Application Layer Gateway Service", "description": "Provides support for 3rd party protocol plug-ins for Internet Connection Sharing", "status": "stopped" }, .. ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Service&quot;: &quot;&quot;
    }
}

`GET` /platform/api/service/:name

Get the service status by name.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

The available status will be "running", "stopped", "disabled", or "unknown".
```
{
  &quot;status&quot;: &quot;running&quot;
}
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Service&quot;: &quot;&quot;
    }
}

`PUT` /platform/api/service/:name

Control the service status by name.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

{
  &quot;action&quot;: &quot;start&quot; | &quot;stop&quot; | &quot;restart&quot;
}

Response 204 No Content

The requested operation is successful.

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Service&quot;: &quot;&quot;
    }
}

Terminal

(since rest-server 1.0.1)

`GET` /platform/api/term/ws

Get the web terminal basic information.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
    &quot;os&quot;: &quot;windows&quot; | &quot;linux&quot;,
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`GET` wss://(URL)/platform/api/term/ws

Open a local shell, making it communicate to WebSocket using stdin/stdout.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Message Description

Message Format

Outbound Message ↑

Cmd	Data	Description
1	base64-encoded terminal output	terminal output
2		Pong message (heartbeat)
3	The New Title	Set window title
4	{"font-size":12,"font-family":"serif"}	Set Preferences
5	false	Set auto reconnect
6	1024	Set Buffer Size

Inbound Message ↓

Cmd Data Description
1 base64-encoded terminal input terminal input data
2 Ping message
3 {"columns":128,"rows":21} Resize Terminal

Cmd	Data	Description
1	base64-encoded terminal input	terminal input data
2		Ping message
3	{"columns":128,"rows":21}	Resize Terminal

Peripheral

LED

`GET` /platform/api/perif/led

Get an LED list with high-low values.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

true -> logical high, false -> logical low
```
```json
```

[ true, false, true, false, true, false, true, true ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

`GET` /platform/api/perif/led/:id

Get the specified LED value by index (id)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

true -> logical high, false -> logical low
```
true | false
```

Response 400 Bad Request

{
    &quot;errors&quot;: {
        &quot;LED&quot;: &quot;&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

`PUT` /platform/api/perif/led/:id

Set the value of the specified LED by index (id)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body

true -> logical high, false -> logical low
```
{
    &quot;status&quot;: true | false
}
```
Response 200 OK

Response 400 Bad Request

Invalid Parameters Error

{
    &quot;errors&quot;: {
        &quot;LED&quot;: &quot;&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request body has missing parameters.

{
    &quot;errors&quot;: {
        &quot;validator&quot;: &quot;&quot;
    }
}

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;LED&quot;: &quot;&quot;
    }
}

Watchdog

`GET` /platform/api/perif/wdt

Get hardware watchdog information.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;enabled&quot;: ,
  &quot;type&quot;: &quot;EC Watchdog&quot;,
  &quot;timeoutInSeconds&quot;: 15,
  &quot;timeoutMaxInSeconds&quot;: 255,
  &quot;timeoutMinInSeconds&quot;: 10
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;WDT&quot;: &quot;&quot;
    }
}

`PUT` /platform/api/perif/wdt

Set hardware watchdog enabled or disabled with provided timeout value (optional).

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

The seconds value range is [timeoutMinInSeconds, timeoutMaxInSeconds]

{
  &quot;enabled&quot;: , // required
  &quot;seconds&quot;: [timeoutMinInSeconds, timeoutMaxInSeconds], // optional
}

Response 200 OK

{
  &quot;enabled&quot;: ,
  &quot;seconds&quot;: 
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;WDT&quot;: &quot;&quot;
    }
}

`PUT` /platform/api/perif/wdt/timeout

Set hardware watchdog timeout value (in seconds).

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body

The seconds value range is [timeoutMinInSeconds, timeoutMaxInSeconds]
```
{
  &quot;seconds&quot;: [timeoutMinInSeconds, timeoutMaxInSeconds]
}
```
Response 200 OK
```
{
  &quot;seconds&quot;: 
}
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;WDT&quot;: &quot;&quot;
    }
}

Disk

`GET` /platform/api/perif/disk

Get installed harddisk information, including model name, size, partition list, usage, and S.M.A.R.T. information (if available).

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "name": "\\.\PHYSICALDRIVE0", "sizeBytes": 64017354240, "physicalBlockSizeBytes": 0, "removable": false, "vendor": "(Standard disk drives)", "model": "SQF-S25M4-64G-S9C", "serialNumber": "XXXXXXXXXXXXX", "firmwareRevision": "XXXXX8", "mediaType": "Fixed hard disk media", "partitions": [ { "mountPoint": "C:", "sizeBytes": 63208157184, "freeBytes": 47287078912, "usedBytes": 15921078272, "usedPercent": 25.188328502685938, "readOnly": false } ], "smartAttributes": [ { "id": 1, "name": "Read Error Rate", "statusFlags": 10, "value": 100, "worst": 100, "threshold": 50, "rawData": [ 0, 0, 0, 0, 0, 0 ]

      },
      ...
    ]
  }
]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

`GET` /platform/api/perif/disk (SSE)

Get installed hard disk information via Server-Sent Events (SSE), including model name, size, partition list, usage, and S.M.A.R.T. information (if available).

EventStream

event: message
data: [{&quot;name&quot;:&quot;\\\\.\\PHYSICALDRIVE0&quot;,&quot;sizeBytes&quot;:64017354240,&quot;physicalBlockSizeBytes&quot;:0,&quot;removable&quot;:false,&quot;vendor&quot;:&quot;(Standard disk drives)&quot;,&quot;model&quot;:&quot;SQF-S25M4-64G-S9C&quot;,&quot;serialNumber&quot;:&quot;FF73076C030806395366&quot;,&quot;firmwareRevision&quot;:&quot;S9FMA028&quot;,&quot;mediaType&quot;:&quot;Fixed hard disk media&quot;,&quot;partitions&quot;:[{&quot;mountPoint&quot;:&quot;C:&quot;,&quot;sizeBytes&quot;:63208157184,&quot;freeBytes&quot;:27825188864,&quot;usedBytes&quot;:35382968320,&quot;usedPercent&quot;:55.97848425955465,&quot;readOnly&quot;:false}],"smartAttributes":[{&quot;id&quot;:1,&quot;name&quot;:&quot;Read Error Rate&quot;,&quot;statusFlags&quot;:10,&quot;value&quot;:100,&quot;worst&quot;:100,&quot;threshold&quot;:50,&quot;rawData&quot;:[0,0,0,0,0,0]},{&quot;id&quot;:9,&quot;name&quot;:&quot;Power-On Hours (POH)&quot;,&quot;statusFlags&quot;:18,&quot;value&quot;:100,&quot;worst&quot;:100,&quot;threshold&quot;:0,&quot;rawData&quot;:[118,38,0,0,0,0]},{&quot;id&quot;:12,&quot;name&quot;:&quot;Power Cycle Count&quot;,&quot;statusFlags&quot;:18,&quot;value&quot;:100,&quot;worst&quot;:100,&quot;threshold&quot;:0,&quot;rawData&quot;:[219,0,0,0,0,0]},{&quot;id&quot;:168,&quot;name&quot;:&quot;Vendor Specific&quot;,&quot;statusFlags&quot;:18,&quot;value&quot;:100,&quot;worst&quot;:100,&quot;threshold&quot;:0,&quot;rawData&quot;:[0,0,0,0,0,0]},{&quot;id&quot;:170,&quot;name&quot;:&quot;Vendor Specific&quot;,&quot;statusFlags&quot;:3,&quot;value&quot;:86,&quot;worst&quot;:86,&quot;threshold&quot;:10,&quot;rawData&quot;:[52,0,0,0,0,0]},{&quot;id&quot;:173,&quot;name&quot;:&quot;Vendor Specific&quot;,&quot;statusFlags&quot;:18,&quot;value&quot;:100,&quot;worst&quot;:100,&quot;threshold&quot;:0,&quot;rawData&quot;:[203,11,158,0,0,0]},{&quot;id&quot;:192,&quot;name&quot;:&quot;Power-off Retract Count&quot;,&quot;statusFlags&quot;:18,&quot;value&quot;:100,&quot;worst&quot;:100,&quot;threshold&quot;:0,&quot;rawData&quot;:[21,0,0,0,0,0]},{&quot;id&quot;:194,&quot;name&quot;:&quot;Temperature&quot;,&quot;statusFlags&quot;:35,&quot;value&quot;:70,&quot;worst&quot;:70,&quot;threshold&quot;:0,&quot;rawData&quot;:[30,0,0,0,0,0]},{&quot;id&quot;:218,&quot;name&quot;:&quot;Vendor Specific&quot;,&quot;statusFlags&quot;:11,&quot;value&quot;:100,&quot;worst&quot;:100,&quot;threshold&quot;:50,&quot;rawData&quot;:[0,0,0,0,0,0]}]}]

`GET` /platform/api/perif/disk/partition

Get the partition list of installed disks.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "mountPoint": "C:", "sizeBytes": 63208157184, "freeBytes": 27825188864, "usedBytes": 35382968320, "usedPercent": 55.97848425955465, "readOnly": false } ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Redundant Power

`GET` /platform/api/perif/redundant_power

Get redundant power status.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

1: online 0: offline

{
  &quot;vin1State&quot;: 0 | 1,
  &quot;vin2State&quot;: 0 | 1
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

`GET` /platform/api/perif/redundant_power (SSE)

Get redundant power status via Server-Sent Events (SSE).

EventStream

event: message
data: {
  &quot;vin1State&quot;: 0 | 1,
  &quot;vin2State&quot;: 0 | 1
}

GPIO

(since rest-server v0.15.1)

`GET` /platform/api/perif/gpio/count

Get available GPIO count.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
{
  &quot;count&quot;: 8,
}
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`GET` /platform/api/perif/gpio/all

Get all the available GPIO pins configuration.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
```json
```

[ { "pin": 0, // 0-based pin index (:id) "dir": 0, // direction. 0: output, 1: input "level": 0 // level. 0: low, 1: high }, { "pin": 1, "dir": 1, "level": 1 }, ... { "pin": 7, "dir": 1, "level": 1 } ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;&quot;
    }
}

`GET` /platform/api/perif/gpio/:id

Get the specified GPIO pin (by index :id) direction and level.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;pin&quot;: 0,    // 0-based pin index (:id)
  &quot;dir&quot;: 0,    // dir. 0: output, 1: input
  &quot;level&quot;: 0,  // level. 0: low, 1: high
},

Response 400 Bad Request

Invalid parameter (incorrect :id)

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;invalid parameter&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;&quot;
    }
}

`GET` /platform/api/perif/gpio/:id/dir

Get the specified GPIO pin (by index :id) direction.

0: output, 1: input

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;dir&quot;: 0,  // direction. 0: output, 1: input
},

Response 400 Bad Request

Invalid parameter (incorrect :id)

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;invalid parameter&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;&quot;
    }
}

`PUT` /platform/api/perif/gpio/:id/dir

Set the specified GPIO pin (by index :id) direction.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body

0: output, 1: input
```
{
    &quot;dir&quot;: 0 | 1
}
```
Response 200 OK

Response 400 Bad Request

Invalid parameter (incorrect :id)

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;invalid parameter&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request body has missing parameters.

{
    &quot;errors&quot;: {
        &quot;validator&quot;: &quot;&quot;
    }
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;&quot;
    }
}

`GET` /platform/api/perif/gpio/:id/level

Get the specified GPIO pin (by index :id) level.

0: low, 1: high

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;level&quot;: 0,  // level. 0: low, 1: high
},

Response 400 Bad Request

Invalid parameter (incorrect :id)

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;invalid parameter&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;&quot;
    }
}

`PUT` /platform/api/perif/gpio/:id/level

Set the specified GPO pin (by index :id) level.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body

0: low, 1: high
```
{
    &quot;level&quot;: 0 | 1
}
```
Response 200 OK

Response 400 Bad Request

Invalid parameter (incorrect :id)

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;invalid parameter&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

Response 422 Unprocessable Entity

The request body has missing parameters.

{
    &quot;errors&quot;: {
        &quot;validator&quot;: &quot;&quot;
    }
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;GPIO&quot;: &quot;&quot;
    }
}

Brightness

(since rest-server v0.16.1)

`GET` /platform/api/perif/brightness

Get the brightness information, including brightness minimum, maximum, and value.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
  &quot;min&quot;: 0,    // the supported minimum brightness value
  &quot;max&quot;: 9,    // the supported maximum brightness value
  &quot;value&quot;: 5,  // the current brightness value
},

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Brightness&quot;: &quot;&quot;
    }
}

`PUT` /platform/api/perif/brightness

Set the brightness value.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body
```
{
    &quot;value&quot;: 1
}
```
Response 200 OK

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Brightness&quot;: &quot;&quot;
    }
}

Networking

`GET` /platform/api/networking/interfaces

Get network adapters' information and the current IP configuration.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Empty if there is no network adapter found.
```
```json
```

[ { "ifIndex": 2, "uuid": "enp0s31f6", "name": "enp0s31f6", "description": "", "type": "Ethernet", "typeId": 1, "mtu": 1500, "connected": true, "isDefault": false, "hardwareAddress": "xx:xx:xx:xx:xx:xx", "speed": "1 Gbps", "sendSpeed": 1000000000, "recvSpeed": 1000000000, "addresses": [ "172.16.12.91/23", "fe80::6543:2799:56b0:78b/64" ], "gateway": [ "192.168.6.1" ], "dns": [ "192.168.6.1" ], "iocounters": { "ifindex": 2, "bytesSent": 518832090, "bytesRecv": 5103663236, "packetsSent": 593021, "packetsRecv": 58711134, "errin": 0, "errout": 0, "dropin": 0, "dropout": 0, "fifoin": 0, "fifoout": 0 } }, { "ifIndex": 3, "uuid": "enp1s0", "name": "enp1s0", "description": "", "type": "Wi-Fi", "typeId": 71, "mtu": 1500, "connected": false, "isDefault": false, "hardwareAddress": "xx:xx:xx:xx:xx:xx" },

]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`GET` /platform/api/networking/interfaces (SSE)

Get network adapters' information and the current IP configuration via Server-Sent Events (SSE).

EventStream

event: message
data: [{&quot;ifIndex&quot;:17,&quot;uuid&quot;:&quot;{B30C1205-A9C3-4155-9E01-0AB4D5A36DB4}","name":"Ethernet 4","description":"Intel(R) Ethernet Connection I219-LM","type":"Ethernet","typeId":6,"mtu":1500,"connected":true,"isDefault":false,"dhcpEnabled":true,"hardwareAddress":"74:FE:48:05:0A:EE","sendSpeed":1000000000,"recvSpeed":1000000000,"addresses":["172.16.12.60/23","fe80::4013:3d5e:69a7:460a/64"],"gateway":["172.16.13.254"],"dns":["172.20.1.99","8.8.8.8"],"dnssuffix":"ADVANTECH.CORP","ipv4Metric":1,"ipv6Metric":25,"iocounters":{&quot;ifindex&quot;:17,&quot;bytesSent&quot;:2721740020,&quot;bytesRecv&quot;:6232829747,&quot;packetsSent&quot;:4159260,&quot;packetsRecv&quot;:3706395,&quot;errin&quot;:0,&quot;errout&quot;:0,&quot;dropin&quot;:0,&quot;dropout&quot;:0,&quot;fifoin&quot;:0,&quot;fifoout&quot;:0}},...]

`POST` /platform/api/networking/interfaces/route

Change the sequence of the network interface route (metric).

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

The sortedGUIDList is an interface uuid list by order of priority.

{
  &quot;ipv6&quot;: false,
  &quot;sortedGUIDList&quot;: [
    &quot;{B30C1205-A9C3-4155-9E01-0AB4D5A36DB4}",
    "{53E59828-224E-4416-9A05-DE95EB7F4C4A}",
    "{EFCDC03D-30CA-434D-B284-DB517179D7FD}",
    "{D1A142DB-C5F9-40D4-9F1B-A1FE2BE89C33}",
    "{5A0E29AC-4767-4EAB-A2F5-F718F343B198}",
    "{D09F45AC-3A17-4012-B278-45B923978278}",
    "{94CDC116-21A5-4419-90AF-F0626B643566}",
    "{1BB8C682-3B29-47A6-9504-44542CAF918E}"
  ]
}

Response 201 Created

Response 400 Bad Request

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;networking&quot;: &quot;&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request body has missing parameters.

{
    &quot;errors&quot;: {
        &quot;validator&quot;: &quot;&quot;
    }
}

The sortedGUIDList is empty or not provided.

{
    &quot;errors&quot;: {
        &quot;networking&quot;: &quot;empty list&quot;
    }
}

`PUT` /platform/api/networking/ipv4config/:ifIndex

Sets the IPv4 configuration with static IP and DNS. You can call GET /platform/api/networking/interfaces to get the ifIndex.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body

  {
      &quot;ipAddress&quot;: &quot;xxx.xxx.xxx.xxx&quot;,
      &quot;subnetMask&quot;: &quot;xxx.xxx.xxx.xxx&quot;,
      &quot;defaultGateway&quot;: &quot;xxx.xxx.xxx.xxx&quot;,
      &quot;primaryDNS&quot;: &quot;xxx.xxx.xxx.xxx&quot;,
      &quot;secondaryDNS&quot;: null // optional
  }

Response 200 OK

  {
      &quot;ipAddress&quot;: &quot;&quot;,
      &quot;subnetMask&quot;: &quot;&quot;,
      &quot;defaultGateway&quot;: &quot;&quot;,
      &quot;primaryDNS&quot;: &quot;&quot;,
      &quot;secondaryDNS&quot;: &quot;&quot;
  }

Response 422 Unprocessable Entity

The request body has missing parameters.

{
    &quot;errors&quot;: {
        &quot;validator&quot;: &quot;&quot;
    }
}

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Net&quot;: &quot;&quot;
    }
}

`DELETE` /platform/api/networking/ipv4config/:ifIndex

Enable DHCP for the specified interface. You can call GET /platform/api/networking/interfaces to get the ifIndex.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Response 422 Unprocessable Entity

There are missing parameters.

{
    &quot;errors&quot;: {
        &quot;Net&quot;: &quot;&quot;
    }
}

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Net&quot;: &quot;&quot;
    }
}

`GET` /platform/api/networking/wifi/interfaces

Get Wi-Fi adapters information.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Empty if there is no network adapter found.
```
```json
```

[ { "ifIndex": 14, "uuid": "{94CDC116-21A5-4419-90AF-F0626B643566}", "description": "802.11n USB Wireless LAN Card", "profiles": [ { "name": "SQA_2.4G", "allUserProfile": true, "groupPolicyProfile": false, "perUserProfile": false } ]

}
]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`GET` /platform/api/networking/wifi/networks/:uuid

Get a list of all available networks of the specified Wi-Fi adapter selected by uuid.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Empty if there is no available network found.
```
```json
```

[ { "alreadyConnected": true, "authenticationAlgorithm": "WPA2-Personal", "channel": 7, "cipherAlgorithm": "AES", "connectable": true, "infrastructureType": "Infrastructure", "profileAvailable": true, "profileName": "SQA_2.4G", "ssid": "SQA_2.4G", "securityEnabled": true, "signalQuality": 100, "signalStrength": -50, "bssid": "E0:3F:49:00:04:30", "physicalTypes": [ "802.11n" ]

    },
    {
        &quot;alreadyConnected&quot;: false,
        &quot;authenticationAlgorithm&quot;: &quot;WPA2-Personal&quot;,
        &quot;cipherAlgorithm&quot;: &quot;AES&quot;,
        &quot;connectable&quot;: true,
        &quot;infrastructureType&quot;: &quot;Infrastructure&quot;,
        &quot;profileAvailable&quot;: false,
        &quot;profileName&quot;: &quot;&quot;,
        &quot;ssid&quot;: &quot;FIVEGGGGGHZ&quot;,
        &quot;securityEnabled&quot;: true,
        &quot;signalQuality&quot;: 30,
        &quot;signalStrength&quot;: -85,
        &quot;physicalTypes&quot;: [
            &quot;802.11ac&quot;
        ]
    },
    ...
]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;WiFi&quot;: &quot;&quot;
    }
}

`DELETE` /platform/api/networking/wifi/interface/:uuid/profile/:name

Delete the connected network profile (selected by profile name) of the specified Wi-Fi interface (selected by uuid)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Profile deleted.

Response 400 Bad Request

The profile name is empty.

{
    &quot;errors&quot;: {
        &quot;WiFi&quot;: &quot;invalid profile name&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;WiFi&quot;: &quot;&quot;
    }
}

Process Manager

`GET` /platform/api/processes

Get running processes list.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Empty if there is no running process found.
```
```json
```

[ { "pid": 1, "name": "systemd", "numThreads": 1, "memUsage": 9187328, "cpuPercent": 0.0010817868420981225, "username": "root", "elapsedTime": 1191547, "path": "/lib/systemd/systemd", "cmdline": "/sbin/init splash" }, { "pid": 2, "name": "kthreadd", "numThreads": 1, "memUsage": 0, "cpuPercent": 0.000013427920447930759, "username": "root", "elapsedTime": 1191547 }, ... ]

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

`GET` /platform/api/processes (SSE)

Get running processes list via Server-Sent Events (SSE)

EventStream

event: message
data: [{&quot;pid&quot;:4,&quot;name&quot;:&quot;System&quot;,&quot;numThreads&quot;:169,&quot;memUsage&quot;:20480,&quot;cpuPercent&quot;:6,&quot;username&quot;:&quot;NT AUTHORITY\\SYSTEM&quot;,&quot;elapsedTime&quot;:876611},{&quot;pid&quot;:56,&quot;ppid&quot;:4,&quot;name&quot;:&quot;Secure System&quot;,&quot;memUsage&quot;:23273472,&quot;cpuPercent&quot;:0,&quot;username&quot;:&quot;NT AUTHORITY\\SYSTEM&quot;,&quot;elapsedTime&quot;:876613},{&quot;pid&quot;:100,&quot;ppid&quot;:4,&quot;name&quot;:&quot;Registry&quot;,&quot;numThreads&quot;:4,&quot;memUsage&quot;:208896,&quot;cpuPercent&quot;:0,&quot;username&quot;:&quot;NT AUTHORITY\\SYSTEM&quot;,&quot;elapsedTime&quot;:876612},{&quot;pid&quot;:416,&quot;ppid&quot;:4,&quot;name&quot;:&quot;smss.exe&quot;,&quot;numThreads&quot;:2,&quot;memUsage&quot;:98304,&quot;cpuPercent&quot;:0,&quot;username&quot;:&quot;NT AUTHORITY\\SYSTEM&quot;,&quot;elapsedTime&quot;:876611},{&quot;pid&quot;:604,&quot;ppid&quot;:572,&quot;name&quot;:&quot;csrss.exe&quot;,&quot;numThreads&quot;:12,&quot;memUsage&quot;:671744,&quot;cpuPercent&quot;:0,&quot;username&quot;:&quot;NT AUTHORITY\\SYSTEM&quot;,&quot;elapsedTime&quot;:876609}, ...]

`DELETE` /platform/api/processes/:pid

Kill the selected process (selected by pid)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Profile deleted.

Response 400 Bad Request

The :pid is not a valid value.

{
    &quot;errors&quot;: {
        &quot;Processes&quot;: &quot;Invalid PID&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Processes&quot;: &quot;&quot;
    }
}

Remote Control

`POST` /platform/api/control/reboot

Restart the target computer. It requires Admin permission.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 403 Forbidden

The login user has no permission to reboot the target computer.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Control&quot;: &quot;&quot;
    }
}

`POST` /platform/api/control/shutdown

Shut down the target computer. It requires Admin permission.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 403 Forbidden

The login user has no permission to shut down the target computer.

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Control&quot;: &quot;&quot;
    }
}

`GET` /platform/api/control/display

Check whether the target computer supports the display on/off feature. (since rest-server 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 204 No Content

The target computer supports the display on/off feature.

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

The target computer does not support the display on/off feature.

`PUT` /platform/api/control/display

Turn the display of the target computer on or off. (since rest-server 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

{
    &quot;status&quot;: &quot;on&quot; | &quot;off&quot;
}

Response 200 OK

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;Control&quot;: &quot;&quot;
    }
}

Remote Desktop

`POST` /platform/api/rdesk/config

Gets the remote desktop connection information via WebSocket.

Request Headers
- Include a valid JWT token obtained by logging in with the OS or "admin" account.
```
Authorization: Bearer 
```
Response Codes
- 200 OK (Success)
  - Response body contains:
    - id (string): The unique identifier (UUID) for the remote desktop connection.
    - os (string, optional): Operating system of the remote desktop (e.g., "windows", "linux").
    - password (string): The password for the remote desktop connection.
```
{
  &quot;id&quot;: &quot;5b306b78-d720-4dac-984e-a1f1ca9cd963&quot;,
  &quot;os&quot;: &quot;windows&quot;,
  &quot;password&quot;: &quot;EmzE4lo0&quot;
}
```
- 401 Unauthorized (Authentication failure)
```
{
  &quot;Code&quot;: 401,
  &quot;Message&quot;: &quot;&quot;
}
```
- 422 Unprocessable Entity (Invalid request)
```
{
  &quot;message&quot;: &quot;&quot;
}
```

`GET` wss://[host:port]/platform/api/rdesk/:id

Opens a WebSocket connection to communicate with the VNC server for the specified remote desktop.

Request Parameters
- :id (string): The unique identifier (UUID) obtained from the response body of the POST /platform/api/rdesk/config endpoint. This ID identifies the specific remote desktop connection.
Request Headers
- Include a valid JWT token obtained by logging in with the OS or "admin" account.
```
Authorization: Bearer 
```
Message Description

The WebSocket connection uses a binary message format to proxy data between the client and the VNC server. The specific format of these messages depends on the VNC protocol version used by the server.
- Consult the VNC protocol specifications (https://tools.ietf.org/html/rfc6143) for detailed information about message structure and data types.

Client-Side Considerations

Utilize the noVNC client-side library (https://github.com/novnc) to establish the WebSocket connection and handle binary VNC message communication.
Refer to the noVNC documentation for specific integration and usage instructions.

Events

`GET` /platform/api/events (SSE)

Get all available Server-Sent Events (SSE), including the following events (event type).

diskdrives
hwmon
netifaces
processes
pwrstatus
snmptrap
systemperf

EventStream

event: 
data:

Example

addEventListener

const eventSource = new EventSource(`/platform/api/   events?token=`, { withCredentials: true });
eventSource.addEventListener(, (event) => {
  const data = JSON.parse(event.data);
  // process your data
});

ETP

`GET` /platform/api/etp/devicedata

Get ETP device data.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
    &quot;modelName&quot;: &quot;XXXXX&quot;,
    &quot;serialNumber&quot;: &quot;Default string&quot;,
    &quot;boardVersion&quot;: &quot;Default string&quot;,
    &quot;uuid&quot;: &quot;00020003-0004-0005-0006-000700080009&quot;,
    &quot;version&quot;: &quot;&quot;
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 204 No Content

Not supported or no available data.

`GET` /platform/api/etp/userdata

Get ETP user's data.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
    &quot;data&quot;: {
        &quot;userSpace1&quot;: &quot;&quot;,
        &quot;userSpace2&quot;: &quot;&quot;
    },
    "locked": true | false
}

Response 400 Bad Request

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

`GET` /platform/api/etp/userdata/lockstatus

Get ETP user data area lockstatus.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
{
  &quot;locked&quot;: true | false
}
```

Response 400 Bad Request

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported or no available data.

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

`PUT` /platform/api/etp/userdata

Set ETP user's data.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

The maximum length of userSpace1 and userSpace2 is 128 bytes. (RAW data)

{
  &quot;userSpace1&quot;: &quot;&quot;,
  &quot;userSpace2&quot;: &quot;&quot;
}

Response 200 OK

{
  &quot;userSpace1&quot;: &quot;&quot;,
  &quot;userSpace2&quot;: &quot;&quot;
}

Response 400 Bad Request

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported.

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

Response 422 Unprocessable Entity

The request body has missing parameters.

{
    &quot;errors&quot;: {
        &quot;validator&quot;: &quot;&quot;
    }
}

The userSpace1 or userSpace2 raw data length is out of range (128 bytes).

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;The maximum length of UserSpace1 is 128&quot;
    }
}

`PUT` /platform/api/etp/userdata/lockstatus

Lock or unlock the ETP user's data area.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

The maximum length of password is 8 byre.

{
  &quot;locked&quot;: true | false,
  &quot;password&quot;: &quot;&quot;
}

Response 200 OK

{
  &quot;locked&quot;: true | false, // same as request body
}

Response 400 Bad Request

The request has been applied but got errors.

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

Not supported.

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

Response 422 Unprocessable Entity

The request body has missing parameters.

{
    &quot;errors&quot;: {
        &quot;validator&quot;: &quot;&quot;
    }
}

The password length is out of range (1~8 bytes).

{
    &quot;errors&quot;: {
        &quot;ETP&quot;: &quot;&quot;
    }
}

EdgeHub

`GET` /edgehub/api/ping

Ping the server to see if it is still alive.

Response 200 OK
- Body
```
pong
```

`GET` /edgehub/api/agentinfo

Get the agent information. (since v0.15.1)

Response 200 OK

Request Successfully

Body

{
  &quot;version&quot;:&quot;v0.15.1&quot;
}

`GET` /edgehub/api/macaddr

Get MAC address for device registration.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
"XX:XX:XX:XX:XX:XX"
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

No available data.
Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`GET` /edgehub/api/connection

Get connection status.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
    &quot;enabled&quot;: true | false,
    &quot;status&quot;: &quot;connected | disconnected&quot;,
    &quot;certRevoked&quot;: true | false, // since 1.2.0
    &quot;stormDetected&quot;: true | false // since 1.3.1
}

certRevoked: indicates whether the certificates are revoked or not

stormDetected: indicates whether there is a connection storm

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`POST` /edgehub/api/connection

Enable or Disable to the device connection.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

conncfg is optional.

If the op is "connect" and the conncfg has been provided, it will set the connection setting first, then enable the connection to the cloud; if the conncfg is not provided, it will enable the connection only.

If the op is "disconnect", it will disable the cloud connection. conncfg will be ignored.

{
    &quot;op&quot;: &quot;connect | disconnect&quot;,
    &quot;conncfg&quot;: {
        &quot;username&quot;: &quot;&quot;,
        &quot;password&quot;: &quot;&quot;,
        &quot;mqttHost&quot;: &quot;&quot;,
        &quot;mqttPort&quot;: 1883,
        &quot;enableTLS&quot;: true | false,
        &quot;overWebSocket&quot;: true | false,
        &quot;connectionString&quot;: &quot;&quot;, // optional
        &quot;mac&quot;: &quot;AABBCCDDEEFF&quot;, // optional,
        &quot;uuid&quot;: &quot;123e4567-e89b-12d3-a456-426614174000&quot;, // optional
        &quot;deviceon&quot;: { // optional (since edgehub-agent 1.0.1)
          &quot;dccsUrl&quot;: &quot;&quot;,
          &quot;iotKey&quot;: &quot;&quot;
        }
    }
}

{
    &quot;op&quot;: &quot;connect | disconnect&quot;,
    &quot;conncfg&quot;: {
        // (since edgehub-agent 1.1.0)
        &quot;deviceTokenCredential&quot;: &quot;&quot;,
        &quot;skipCertVerify&quot;: true | false,
        &quot;deviceon&quot;: { // optional (since edgehub-agent 1.0.1)
          &quot;dccsUrl&quot;: &quot;&quot;,
          &quot;iotKey&quot;: &quot;&quot;
        }
    }
}

Response 200 OK

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

No available data.
Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`GET` /edgehub/api/conncfg

Get the current device connection setting.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
    &quot;username&quot;: &quot;&quot;,
    &quot;password&quot;: &quot;&quot;,
    &quot;mqttHost&quot;: &quot;&quot;,
    &quot;mqttPort&quot;: 1883,
    &quot;enableTLS&quot;: true | false,
    &quot;overWebSocket&quot;: true | false,
    &quot;connectionString&quot;: &quot;&quot;, // optional
    &quot;mac&quot;: &quot;AABBCCDDEEFF&quot;, // optional,
    &quot;uuid&quot;: &quot;123e4567-e89b-12d3-a456-426614174000&quot;, // optional,
    &quot;skipCertVerify&quot;: true | false,
    // (since edgehub-agent 1.1.0)
    &quot;deviceTokenCredential&quot;: &quot;&quot;,
    &quot;caCerts&quot;: [&quot;&quot;, ...],
    &quot;iothubKey&quot;: &quot;&quot;,
    &quot;iothubCert&quot;: &quot;&quot;,
    &quot;mqttKey&quot;: &quot;&quot;,
    &quot;mqttCert&quot;: &quot;&quot;
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

No available data.
Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`POST` /edgehub/api/conncfg

Set the connection setting.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

{
    &quot;username&quot;: &quot;&quot;,
    &quot;password&quot;: &quot;&quot;,
    &quot;mqttHost&quot;: &quot;&quot;,
    &quot;mqttPort&quot;: 1883,
    &quot;enableTLS&quot;: true | false,
    &quot;overWebSocket&quot;: true | false,
    &quot;connectionString&quot;: &quot;&quot;, // optional
    &quot;mac&quot;: &quot;AABBCCDDEEFF&quot;, // optional
    &quot;uuid&quot;: &quot;123e4567-e89b-12d3-a456-426614174000&quot;, // optional
    &quot;deviceon&quot;: { // optional (since edgehub-agent 1.0.1)
      &quot;dccsUrl&quot;: &quot;&quot;,
      &quot;iotKey&quot;: &quot;&quot;
    }
}

{
    // (since edgehub-agent 1.1.0)
    &quot;deviceTokenCredential&quot;: &quot;&quot;,
    &quot;deviceon&quot;: { // optional (since edgehub-agent 1.0.1)
      &quot;dccsUrl&quot;: &quot;&quot;,
      &quot;iotKey&quot;: &quot;&quot;
    },
    "skipCertVerify": true | false,
    "caCerts": ["", ...], // optional
}

Response 200 OK
```
{
    // same as request body
}
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 404 Not Found

No available data.
Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`DELETE` /edgehub/api/conncfg

Clear the current device connection setting.

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`GET` /edgehub/api/profile

Get the EdgeHub function profile which contains the agent versions and function support status. It's will be sent to the cloud via MQTT topic Advantech//update/platform/profile (since edgehub-agent 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
    &quot;agent:version:auth-server&quot;: &quot;v1.9.1&quot;,
    &quot;agent:version:edgehub-agent&quot;: &quot;v1.0.2&quot;,
    &quot;agent:version:edgex-helper&quot;: &quot;v0.6.1&quot;,
    &quot;agent:version:portal-service&quot;: &quot;v1.0.1&quot;,
    &quot;agent:version:rest-server&quot;: &quot;v1.0.1&quot;,
    &quot;apphub&quot;: 2,
    &quot;host:display:count&quot;: 1,
    &quot;host:info&quot;: 1,
    &quot;hwmon&quot;: 1,
    &quot;ibmc&quot;: 0,
    &quot;model:name&quot;: &quot;UNO-2484G-673xAE&quot;,
    &quot;networking:interfaces&quot;: 5,
    &quot;os&quot;: &quot;windows&quot;,
    &quot;os:arch&quot;: &quot;x86_64&quot;,
    &quot;os:description&quot;: &quot;Microsoft Windows 10 Enterprise LTSC 2019&quot;,
    &quot;perif:brightness&quot;: 0,
    &quot;perif:disk&quot;: 1,
    &quot;perif:gpio:all&quot;: 0,
    &quot;perif:gpio:count&quot;: 0,
    &quot;perif:led&quot;: 0,
    &quot;perif:wdt&quot;: 1,
    &quot;perif:wdt:enabled&quot;: false,
    &quot;perif:wdt:timeoutInSeconds&quot;: 60,
    &quot;perif:wdt:timeoutMaxInSeconds&quot;: 255,
    &quot;perif:wdt:timeoutMinInSeconds&quot;: 10,
    &quot;perif:wdt:type&quot;: &quot;EC&quot;,
    &quot;processes&quot;: 194,
    &quot;service:list&quot;: 1,
    &quot;system:ip&quot;: &quot;172.16.12.123&quot;,
    &quot;system:mac&quot;: &quot;00:0b:ab:12:34:56&quot;,
    &quot;systemperf&quot;: 1
}

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`POST` /edgehub/api/data

Send tag data to the cloud. (since edgehub-agent 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

{
    &quot;string_data&quot;: &quot;abcdefg...&quot;,
    &quot;number_data&quot;: 12345,
    &quot;bool_data&quot;: true,
}

Response 201 Created

The data has been sent successfully.

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 400 Bad Requset

The request data is empty, invalid format, or incorrect value.
```
{
    &quot;message&quot;: &quot;&quot;
}
```
Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`GET` /edgehub/api/apphub/status

Get the AppHub service running status. (since edgehub-agent 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Response 200 OK
```
{
    &quot;status&quot;: &quot;running&quot;,
}
```
Note: The possible status values are "unknown or not available", "running", "stopped", "**unknown status: **"
Response 404 Not Found

It indicates there is no AppHub service installed.

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`PUT` /edgehub/api/apphub/service

Control the AppHub service status. (since edgehub-agent 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

{
  &quot;action&quot;: &quot;start&quot; | &quot;stop&quot; | &quot;restart&quot;
}

Response 204 No Content

The requested operation is successful.

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`PUT` /edgehub/api/apphub/log/config

Set up the AppHub log configuration. (since edgehub-agent 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Request Body

Setup logFile and logLevel simultaneously.

{
    &quot;logFile&quot;: true | false,
    &quot;logLevel&quot;: &quot;error&quot; | &quot;info&quot;
}

Setup logFile only.
```
{
    &quot;logFile&quot;: true | false
}
```

Setup logLevel only.

{
    &quot;logLevel&quot;: &quot;error&quot; | &quot;info&quot;
}

Response 204 No Content

The requested operation is successful.

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 400 Bad Requset

The request data is empty, invalid format, or incorrect value.
```
{
    &quot;message&quot;: &quot;&quot;
}
```
Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`GET` /edgehub/api/edgebus/status

Get the EdgeBus (Embedded Broker) running status. (since edgehub-agent 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```

Response 200 OK

{
    &quot;enabled&quot;: true,
    &quot;mqttBrokerStatus&quot;: {
        &quot;version&quot;: &quot;2.2.8&quot;,
        &quot;started&quot;: 1683597812,
        &quot;time&quot;: 1683786741,
        &quot;uptime&quot;: 188929,
        &quot;bytes_received&quot;: 1107413,
        &quot;bytes_sent&quot;: 1090102,
        &quot;clients_connected&quot;: 2,
        &quot;clients_disconnected&quot;: 0,
        &quot;clients_maximum&quot;: 2,
        &quot;clients_total&quot;: 2,
        &quot;messages_received&quot;: 10437,
        &quot;messages_sent&quot;: 10489,
        &quot;retained&quot;: 0,
        &quot;inflight&quot;: 0,
        &quot;inflight_dropped&quot;: 0,
        &quot;subscriptions&quot;: 3,
        &quot;packets_received&quot;: 23949,
        &quot;packets_sent&quot;: 24001,
        &quot;memory_alloc&quot;: 7553024,
        &quot;threads&quot;: 75
    },
    "clientStatus": "connected"
}

Response 404 Not Found

It indicates there is no EdgeBus service support.

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

`PUT` /edgehub/api/edgebus/config

Set up the EdgeBus (Embedded Broker) configuration. (since edgehub-agent 1.0.1)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body

Enable or Disable the EdgeBus (Embedded Broker).
```
{
    &quot;enabled&quot;: false
}
```
Response 200 OK

Same as the request body.
```
{
    &quot;enabled&quot;: false
}
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`POST` /edgehub/api/pem/temp

Upload a PEM file and encode it to a base64 string if the file is valid. (since edgehub-agent 1.1.0)

Request Headers

Log in with your OS account or the admin account to get the JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body

The request body must be multipart/form-data with a field name file and the value is the File containing the PEM data to upload.
Response 200 OK

The type is the PEM file type, such as CERTIFICATE, PRIVATE KEY. The data is the base64-encoded PEM file content.
```
{
  &quot;type&quot;: &quot;CERTIFICATE&quot;,
  &quot;data&quot;: &quot;&quot;
}
```

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request has been applied but got errors.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

`PUT` /edgehub/api/bootstrap/config

Set up the EdgeHub Mass Deployment configuration. (since edgehub-agent 1.5.1, edgehub-suite 1.4.0)

Request Headers

Log in with the OS or the "admin" account to get a JWT token (token field from the response body).
```
Authorization: Bearer 
```
Request Body

The request body should contain the tenant access token obtained from the EdgeHub Mass Deployment tab.
```
{
    &quot;tenantToken&quot;: &quot;eyJ0eXA...&quot;
}
```
- tenantToken: The access token for the specific tenant you want to configure for mass deployment.
Response 201 Created

The configuration has been successfully applied.

Response 401 Unauthorized

{
    &quot;Code&quot;: 401,
    &quot;Message&quot;: &quot;&quot;
}

Response 422 Unprocessable Entity

The request could not be processed due to invalid configuration data. The response will include a JSON object with:
- message: A specific error message detailing the configuration error.
```
{
    &quot;message&quot;: &quot;&quot;
}
```

On this page ...

GET /auth/ping
GET /auth/agentinfo
GET /auth/version
GET /auth/token{?m}
POST /auth/login{?m}
POST /auth/logout
GET /auth/certificate
- PUT /auth/user/admin/password
- DELETE /auth/user/admin/password
GET /platform/api/hwmon
GET /platform/api/hwmon (SSE)
GET /platform/api/hwmon/temperatures
GET /platform/api/hwmon/voltages
GET /platform/api/hwmon/currents
GET /platform/api/hwmon/fanspeeds
GET /platform/api/ping
GET /platform/api/agentinfo
GET /api/ping
GET /api/agentinfo
GET /api/irtm/ping
Host Information
- GET /platform/api/host/info
- GET /platform/api/host/display/count
- GET /platform/api/host/screenshot/
- GET /platform/api/host/screenshot//file
System Performance
- GET /platform/api/systemperf
- GET /platform/api/systemperf/cpu
- GET /platform/api/systemperf/memory
GET /platform/api/devmgr
GET /platform/api/service/list
GET /platform/api/service/
PUT /platform/api/service/
GET /platform/api/term/ws
GET wss://(URL)/platform/api/term/ws
LED
- GET /platform/api/perif/led
- GET /platform/api/perif/led/
- PUT /platform/api/perif/led/
Watchdog
- GET /platform/api/perif/wdt
- PUT /platform/api/perif/wdt
- PUT /platform/api/perif/wdt/timeout
Disk
- GET /platform/api/perif/disk
- GET /platform/api/perif/disk (SSE)
- GET /platform/api/perif/disk/partition
Redundant Power
- GET /platform/api/perif/redundant_power
- GET /platform/api/perif/redundant_power (SSE)
GPIO
- GET /platform/api/perif/gpio/count
- GET /platform/api/perif/gpio/all
- GET /platform/api/perif/gpio/
- GET /platform/api/perif/gpio//dir
- PUT /platform/api/perif/gpio//dir
- GET /platform/api/perif/gpio//level
- PUT /platform/api/perif/gpio//level
Brightness
- GET /platform/api/perif/brightness
- PUT /platform/api/perif/brightness
GET /platform/api/networking/interfaces
GET /platform/api/networking/interfaces (SSE)
POST /platform/api/networking/interfaces/route
PUT /platform/api/networking/ipv4config/
DELETE /platform/api/networking/ipv4config/
GET /platform/api/networking/wifi/interfaces
GET /platform/api/networking/wifi/networks/
- DELETE /platform/api/networking/wifi/interface//profile/
GET /platform/api/processes
GET /platform/api/processes (SSE)
DELETE /platform/api/processes/
POST /platform/api/control/reboot
POST /platform/api/control/shutdown
GET /platform/api/control/display
PUT /platform/api/control/display
POST /platform/api/rdesk/config
GET wss://[host]/platform/api/rdesk/
- Client-Side Considerations
GET /platform/api/events (SSE)
- EventStream
- Example
GET /platform/api/etp/devicedata
GET /platform/api/etp/userdata
GET /platform/api/etp/userdata/lockstatus
PUT /platform/api/etp/userdata
PUT /platform/api/etp/userdata/lockstatus
GET /edgehub/api/ping
GET /edgehub/api/agentinfo
GET /edgehub/api/macaddr
GET /edgehub/api/connection
POST /edgehub/api/connection
GET /edgehub/api/conncfg
POST /edgehub/api/conncfg
DELETE /edgehub/api/conncfg
GET /edgehub/api/profile
POST /edgehub/api/data
GET /edgehub/api/apphub/status
PUT /edgehub/api/apphub/service
PUT /edgehub/api/apphub/log/config
GET /edgehub/api/edgebus/status
PUT /edgehub/api/edgebus/config
POST /edgehub/api/pem/temp
PUT /edgehub/api/bootstrap/config

Authentication

GET /auth/ping​

GET /auth/agentinfo​

GET /auth/version​

GET /auth/token{?m}​

POST /auth/login{?m}​

POST /auth/logout​

GET /auth/certificate​

PUT /auth/user/admin/password​

DELETE /auth/user/admin/password​

H/W Monitor

GET /platform/api/hwmon​

GET /platform/api/hwmon (SSE)​

GET /platform/api/hwmon/temperatures​

GET /platform/api/hwmon/voltages​

GET /platform/api/hwmon/currents​

GET /platform/api/hwmon/fanspeeds​

Platform

GET /platform/api/ping​

GET /platform/api/agentinfo​

Portal

GET /api/ping​

GET /api/agentinfo​

GET /api/irtm/ping​

System Information

Host Information​

GET /platform/api/host/info​

GET /platform/api/host/display/count​

GET /platform/api/host/screenshot/:index​

GET /platform/api/host/screenshot/:index/file​

System Performance​

GET /platform/api/systemperf​

GET /platform/api/systemperf/cpu​

GET /platform/api/systemperf/memory​

System Devices

GET /platform/api/devmgr​

Service

GET /platform/api/service/list​

GET /platform/api/service/:name​

PUT /platform/api/service/:name​

Terminal

GET /platform/api/term/ws​

GET wss://(URL)/platform/api/term/ws​

Peripheral

LED​

GET /platform/api/perif/led​

GET /platform/api/perif/led/:id​

PUT /platform/api/perif/led/:id​

Watchdog​

GET /platform/api/perif/wdt​

PUT /platform/api/perif/wdt​

PUT /platform/api/perif/wdt/timeout​

Disk​

GET /platform/api/perif/disk​

GET /platform/api/perif/disk (SSE)​

GET /platform/api/perif/disk/partition​

Redundant Power​

GET /platform/api/perif/redundant_power​

GET /platform/api/perif/redundant_power (SSE)​

GPIO​

GET /platform/api/perif/gpio/count​

GET /platform/api/perif/gpio/all​

GET /platform/api/perif/gpio/:id​

GET /platform/api/perif/gpio/:id/dir​

PUT /platform/api/perif/gpio/:id/dir​

GET /platform/api/perif/gpio/:id/level​

PUT /platform/api/perif/gpio/:id/level​

Brightness​

GET /platform/api/perif/brightness​

PUT /platform/api/perif/brightness​

Networking

GET /platform/api/networking/interfaces​

GET /platform/api/networking/interfaces (SSE)​

POST /platform/api/networking/interfaces/route​

PUT /platform/api/networking/ipv4config/:ifIndex​

DELETE /platform/api/networking/ipv4config/:ifIndex​

GET /platform/api/networking/wifi/interfaces​

GET /platform/api/networking/wifi/networks/:uuid​

DELETE /platform/api/networking/wifi/interface/:uuid/profile/:name​

Process Manager

`GET` /auth/ping

`GET` /auth/agentinfo

`GET` /auth/version

`GET` /auth/token{?m}

`POST` /auth/login{?m}

`POST` /auth/logout

`GET` /auth/certificate

`PUT` /auth/user/admin/password

`DELETE` /auth/user/admin/password

`GET` /platform/api/hwmon

`GET` /platform/api/hwmon (SSE)

`GET` /platform/api/hwmon/temperatures

`GET` /platform/api/hwmon/voltages

`GET` /platform/api/hwmon/currents

`GET` /platform/api/hwmon/fanspeeds

`GET` /platform/api/ping

`GET` /platform/api/agentinfo

`GET` /api/ping

`GET` /api/agentinfo

`GET` /api/irtm/ping

Host Information

`GET` /platform/api/host/info

`GET` /platform/api/host/display/count

`GET` /platform/api/host/screenshot/:index

`GET` /platform/api/host/screenshot/:index/file

System Performance

`GET` /platform/api/systemperf

`GET` /platform/api/systemperf/cpu

`GET` /platform/api/systemperf/memory

`GET` /platform/api/devmgr

`GET` /platform/api/service/list

`GET` /platform/api/service/:name

`PUT` /platform/api/service/:name

`GET` /platform/api/term/ws

`GET` wss://(URL)/platform/api/term/ws

LED

`GET` /platform/api/perif/led

`GET` /platform/api/perif/led/:id

`PUT` /platform/api/perif/led/:id

Watchdog

`GET` /platform/api/perif/wdt

`PUT` /platform/api/perif/wdt

`PUT` /platform/api/perif/wdt/timeout

Disk

`GET` /platform/api/perif/disk

`GET` /platform/api/perif/disk (SSE)

`GET` /platform/api/perif/disk/partition

Redundant Power

`GET` /platform/api/perif/redundant_power

`GET` /platform/api/perif/redundant_power (SSE)

GPIO

`GET` /platform/api/perif/gpio/count

`GET` /platform/api/perif/gpio/all

`GET` /platform/api/perif/gpio/:id

`GET` /platform/api/perif/gpio/:id/dir

`PUT` /platform/api/perif/gpio/:id/dir

`GET` /platform/api/perif/gpio/:id/level

`PUT` /platform/api/perif/gpio/:id/level

Brightness

`GET` /platform/api/perif/brightness

`PUT` /platform/api/perif/brightness

`GET` /platform/api/networking/interfaces

`GET` /platform/api/networking/interfaces (SSE)

`POST` /platform/api/networking/interfaces/route

`PUT` /platform/api/networking/ipv4config/:ifIndex

`DELETE` /platform/api/networking/ipv4config/:ifIndex

`GET` /platform/api/networking/wifi/interfaces

`GET` /platform/api/networking/wifi/networks/:uuid

`DELETE` /platform/api/networking/wifi/interface/:uuid/profile/:name

`GET` /platform/api/processes

`GET` /platform/api/processes (SSE)

`DELETE` /platform/api/processes/:pid

`POST` /platform/api/control/reboot

`POST` /platform/api/control/shutdown

`GET` /platform/api/control/display

`PUT` /platform/api/control/display

`POST` /platform/api/rdesk/config

`GET` wss://[host:port]/platform/api/rdesk/:id

Client-Side Considerations

`GET` /platform/api/events (SSE)