MQTT Control API
What is a CONTROL API
The broker and several plugins provide so-called control APIs. These APIs are implemented via specific MQTT topics, in a request-response message-workflow.
The broker for example itself provides a $CONTROL/broker/v1
topic, where a client can publish
it's request to.
The broker control API must be enabled explicitly, setting enable_control_api true
in the broker
configuration.
A requested contains a list of commands
and each command
item can have a field
named correlationData
which will be included in the broker response message. A response messages
will be published on the topic $CONTROL/broker/v1/response
.
Every plugin has its own request/response topic and some commands require additional request parameters. The detailed information about these topics and parameters can be found in the sub-pages.