HubServer Interface
Get HubServer clock
GET/api/v6.1/hubserver/clock
| Query parameters | None |
| Request headers | None |
| Request body | None |
| Response headers | None |
| Response body (JSON) | Prototype:
|
| Status codes | ✅ 200 OK ❌ 400 Bad Request |
| Required permissions | No special permission required Available while Setup Mode is active. |
Get HubServer properties
GET/api/v6.1/hubserver/props
| Query parameters | Prototype:
|
| Request headers | Prototype:
|
| Request body | None |
| Response headers | Prototype:
|
| Response body (JSON) | Prototype:
|
| Status codes | ✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: No properties configured |
| Required permissions | No special permission required Available while Setup Mode is active. |
Modify HubServer properties
PATCH/api/v6.1/hubserver/props
| Query parameters | None |
| Request headers | Prototype:
|
| Request body (JSON) | Prototype:
|
| Response headers | None |
| Response body | None |
| Status codes | ✅ 204 No Content ❌ 400 Bad Request |
| Required permissions | SysAdmin access level Available while Setup Mode is active. |
| Events | Creates no events. |
Replace/Create all HubServer properties
PUT/api/v6.1/hubserver/props
| Query parameters | None |
| Request headers | Prototype:
|
| Request body (JSON) | Prototype:
|
| Response headers | None |
| Response body | None |
| Status codes | ✅ 204 No Content ❌ 400 Bad Request |
| Required permissions | SysAdmin access level Available while Setup Mode is active. |
| Events | Creates no events. |
Delete some HubServer properties
POST/api/v6.1/hubserver/props_delete
| Query parameters | None |
| Request headers | None |
| Request body (JSON) | Prototype:
|
| Response headers | None |
| Response body | None |
| Status codes | ✅ 204 No Content ❌ 400 Bad Request |
| Required permissions | SysAdmin access level Available while Setup Mode is active. |
| Events | Creates no events. |
Restart HubServer internals
POST/api/v6.1/hubserver/restart
| Query parameters | None |
| Request headers | None |
| Request body | None |
| Response headers | None |
| Response body | None |
| Status codes | ✅ 202 Accepted: Restarting has begun ❌ 400 Bad Request |
| Required permissions | SysAdmin access level Available while Setup Mode is active. |
| Events | Creates the following event Hub_Server_Restart |
Stop HubServer
POST/api/v6.1/hubserver/stop
| Query parameters | None |
| Request headers | None |
| Request body | None |
| Response headers | None |
| Response body | None |
| Status codes | ✅ 202 Accepted: Stopping has begun ❌ 400 Bad Request |
| Required permissions | SysAdmin access level Available while Setup Mode is active. |
| Events | Creates the following event Hub_Server_Stop |
Create upload ref to be used to upload a file to the server.
POST/api/v6.1/hubserver/upload
| Query parameters | None |
| Request headers | None |
| Request body (JSON) | Prototype:
|
| Response headers | None |
| Response body (JSON) | Prototype:
|
| Status codes | ✅ 200 OK ❌ 400 Bad Request: Invalid file name |
| Required permissions | No special permission required |
| Events | Creates no events. |