This API provides access to
An instance opens an WebSocked endpoint at the configured port and delegates every received message to all assigned plugins. When an instance is running and am assigned plugin was changed then you need to restart the instance.
Property | Type | Description |
---|---|---|
instances | Array<InstanceInfo> |
List of configured WebSocket instances and status information. |
Property | Type | Description |
---|---|---|
id | string |
ID of the instance. |
name | string |
Name of the instance. |
port | number |
The used port number. |
state | string<InstanceState> |
The current state of the instance. |
description | string |
The instance description |
connectionCount | number |
Number of current active connections. |
pluginTotalCount | number |
Number of total assigned plugins. |
pluginActiveCount | number |
Number of active plugins. |
plugins | Array<string> |
List of assigned plugins (IDs). |
activePlugins | Array<string> |
List of active plugins (IDs). |
Restart all running instances.
Start an instance.
Stop an instance.
Create a new instance configuration.
Property | Type | Description |
---|---|---|
instanceConfig | The instance configuration object. |
Property | Type | Description |
---|---|---|
id | string |
The unique instance ID. Shall be URL safe. |
name | string |
Instance name for display purpose. |
description | string |
Instance description for display purpose. |
port | number |
The WebSocket server instance port. |
autoStartEnabled | boolean |
Start WebSocket instance automatically when YAKjs is started. |
plugins | Array<string> |
List of assigned plugins (IDs) that shall be used by this instance. |
Updates an existing instance configuration.
Property | Type | Description |
---|---|---|
instanceConfig | The instance configuration object. |
Deletes an existing instance configuration.