Broker Control 2.6.0

The broker control API gives information about listeners and plugins using the listListeners or listPluginscommand. A broker API request can be published to $CONTROL/broker/v1 and the related response message will be published to $CONTROL/broker/v1/response.

To enable this API add enable_control_api true to your mosquitto.conf.

Operations

  • PUB $CONTROL/broker/v1

    Accepts the following message:

    Request including the commands to be executedcontrolRequest
    object
    uid: controlRequestPayload

    Examples

  • SUB $CONTROL/broker/v1/response

    Accepts the following message:

    Response including the responses of the command requestscontrolResponse
    object
    uid: controlResponsePayload

    Examples

Messages

  • #1Request including the commands to be executedcontrolRequest
    object
    uid: controlRequestPayload
  • #2Response including the responses of the command requestscontrolResponse
    object
    uid: controlResponsePayload

Schemas

  • object
    uid: controlRequestPayload
  • object
    uid: controlResponsePayload
  • correlationData
    string
    uid: correlationData

    This is an optional value to be able to identify the relation between request and response. The plugin will add the provided value in the response message.

      Examples values:
    • "716cc776-d044-4772-b991-d9b55e2e034c"