repositoryGitHub licenseMIT Versionv3.0.5

Modules API

This API provides access to read and write modules. Modules can be used by plugins.

GET /modules/names

Gets a list of all module names.

JSON Response

PropertyTypeDescription
moduleNames

Array<string>

List of available modules by name.

GET /modules/:moduleName

Gets a module.

JSON Response

PropertyTypeDescription
module

Module

The module.

Module

PropertyTypeDescription
name

string

The unique name of the module.
content

string

The module content (e.g. code).

POST /modules

Create a new module.

JSON Request

PropertyTypeDescription
module

Module

The module to create.

BAD_REQUEST (400) Response

PropertyTypeDescription
message

string

Error message when request contains invalid data.

POST /modules/cache/clear

Clears the module cache. A module will be loaded only once when it is used. Clear the cache to load it again on the next require statement of an (plugin)[/plugin].

PUT /modules/:moduleName

Updates an existing module.

JSON Request

PropertyTypeDescription
module

Module

The module object.

DELETE /modules/:moduleName

Deletes an existing module.

Next: Key-Value Store