Plugins API

This API provides access to read and write plugins. A plugin needs to be assigned to a WebSocket server instance to work.

GET /plugins

JSON Response

PropertyTypeDescription
plugins

Array<PluginConfig>

List of configured plugins.

PluginConfig

PropertyTypeDescription
id

string

ID of the plugin.

description

string

Optional: The description provided by the plugin

code

string

The JavaScript plugin code. See chapter plugin how to write a plugin.

POST /plugins/

Create a new plugin.

JSON Request

PropertyTypeDescription
plugin

PluginCode

The plugin configuration object.

PluginCode

PropertyTypeDescription
id

string

ID of the plugin.

code

string

The JavaScript plugin code. See chapter plugin how to write a plugin.

PUT /plugins/:pluginsId

Updates an existing plugin configuration.

JSON Request

PropertyTypeDescription
plugin

PluginCode

The plugin configuration object.

DELETE /plugins/:pluginId

Deletes an existing plugin configuration.