Gateways

Load or update the gateway confs

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}

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/gateways/{name}
  • 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/>

Request body

OR
OR
OR
OR
OR
EmqxGatewayApiExproto required(unresolved $ref)
OR
EmqxGatewayApiLwm2m required(unresolved $ref)
OR
EmqxGatewayApiCoap required(unresolved $ref)
OR
EmqxGatewayApiMqttsn required(unresolved $ref)
OR
EmqxGatewayApiStomp required(unresolved $ref)

Example request

{
  "server": {
    "bind": "127.0.0.1:80",
    "ssl_options": {
      "handshake_timeout": "12m"
    }
  },
  "idle_timeout": "12m"
}

Response

Gateway configuration updated

Changes

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