/modulesendpoint provides creation, management and direct interaction with modules outside of a system context. For more information on the role that modules play, see:
A universally unique ID for this module.
ID of the driver that defines this module.
ID of the system this module is bound to (logic modules only).
ID of the preferred engine node to run on.
IP address or resolvable hostname of the device this module connects to.
True if the device communicates securely.
Protocol uses UDP rather that TCP.
The TCP or UDP port that the associated device communicates on.
If enabled, provides an ephemeral connection that disconnects during idle periods.
The based URI of the remote service (service modules only).
The modules class name (
A JSON object containing module configuration.
Timestamp of last update.
Timestamp of creation.
The module type. One of:
Markdown formatted text that describes this module.
Flag for connectivity state.
Module start/stop state.
If enabled, system metrics ignore connectivity state.
If enabled, system level start and stop actions are ignored. This is recommended for modules shared by many systems (e.g. a lighting gateway).
Queries default to searching for any of the entered terms (words). A small query language provides the ability to structure complex queries.
Matches both terms.
Matches either terms.
Negates a single token.
Wraps tokens to form a phrase.
Specifies edit distance (fuzziness) after a word.
Specifies slop amount (deviation) after a phrase.