Access this instance at HomeyAPIV3Local.system.
Extends
- HomeyAPIV3.ManagerSystem
Methods
getInfo
(async) getInfo(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/system/
Returns
Promise.<any>
getMemoryInfo
(async) getMemoryInfo(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/system/memory
Returns
Promise.<any>
getOptionForwardedPort
(async) getOptionForwardedPort(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/system/option/forwardedPort
Returns
Promise.<any>
getState
(async) getState(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/system/state
Returns
Promise.<any>
getStorageInfo
(async) getStorageInfo(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/system/storage
Returns
Promise.<any>
getSystemName
(async) getSystemName(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/system/name
Returns
Promise.<any>
ping
(async) ping(): Promise.<any>Scopes
-
HTTP
GET /api/manager/system/ping
Returns
Promise.<any>
reboot
(async) reboot(): Promise.<any>Scopes
homey.system
HTTP
POST /api/manager/system/reboot
Returns
Promise.<any>
rebootOTA
(async) rebootOTA(): Promise.<any>Scopes
homey.system
HTTP
POST /api/manager/system/reboot-ota
Returns
Promise.<any>
sendLog
(async) sendLog(opts): Promise.<any>Scopes
homey.system.readonly
HTTP
POST /api/manager/system/journalctl
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
append
|
string
<optional> |
|
|
|
Returns
Promise.<any>
setDebug
(async) setDebug(opts): Promise.<any>Scopes
homey.system
HTTP
PUT /api/manager/system/debug
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
namespace
|
string | |
|
|
Returns
Promise.<any>
setOptionForwardedPort
(async) setOptionForwardedPort(opts): Promise.<any>Scopes
homey.system
HTTP
PUT /api/manager/system/option/forwardedPort
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
value
|
* | |
|
|
Returns
Promise.<any>
setSystemName
(async) setSystemName(opts): Promise.<any>Scopes
homey.system
HTTP
PUT /api/manager/system/name
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
name
|
string | |
|
|
Returns
Promise.<any>
unsetOptionForwardedPort
(async) unsetOptionForwardedPort(): Promise.<any>Scopes
homey.system
HTTP
DELETE /api/manager/system/option/forwardedPort
Returns
Promise.<any>