Gateways

Enable or disable gateway

Update the gateway basic configurations and running status.<br/><br/>Note: The Authentication and Listener configurations should be updated by other special APIs.

put/gateways/{name}/enable/{enable}

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/gateways/{name}/enable/{enable}
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Path parameters

namestring required

Gateway Name.<br/><br/>It's enum with stomp, mqttsn, coap, lwm2m, exproto<br/>

enableboolean required

Whether or not gateway is enabled

Response

Gateway configuration updated

Changes

No recorded changes to this operation across all 1 revision of this API.