Skip to main content

Update MQTT broker config

PUT 
/api/v1/orgs/{orgId}/data-bridges/mqtt-broker-configs/{mqttConfigId}

Update broker endpoint and protocol settings for an existing MQTT broker configuration.

Authentication type and credential secrets are updated only by the credentials endpoint.

Finite values:

  • mqttProtocolVersion: V310, V311, V500
  • checkConnection: true, false

When checkConnection is true, the updated endpoint and protocol are verified using the stored credentials. The request fails if credentials are missing or the broker cannot be reached.

Defaults:

  • mqttProtocolVersion: V311
  • checkConnection: false
  • keepAliveInterval: omitted stores null; runtime uses 60s
  • reconnectInterval: omitted stores null; runtime uses 5s

Example:

{
  "name": "mqtt local updated",
  "brokerEndpoint": "localhost:1883",
  "keepAliveInterval": "60s",
  "reconnectInterval": "5s",
  "mqttProtocolVersion": "V311",
  "checkConnection": false
}

Request​

Responses​

OK