Configs

Update the sub-configurations under zones

put/configs/zones

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/configs/zones
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Request body

Example request

{
  "$name": {
    "mqtt": {
      "idle_timeout": "12m",
      "max_packet_size": "32MB",
      "retry_interval": "12m",
      "await_rel_timeout": "12m",
      "session_expiry_interval": "12m",
      "mqueue_priorities": {}
    },
    "flapping_detect": {
      "window_time": "12m",
      "ban_time": "12m"
    },
    "force_shutdown": {
      "max_heap_size": "1024KB"
    },
    "conn_congestion": {
      "min_alarm_sustain_duration": "12m"
    },
    "force_gc": {
      "bytes": "32MB"
    }
  }
}

Response

A zone is a set of configs grouped by the zone <code>name</code>.<br/>For flexible configuration mapping, the <code>name</code> can be set to a listener's <code>zone</code> config.<br/>NOTE: A built-in zone named <code>default</code> is auto created and can not be deleted.<br/>

Example response

{
  "$name": {
    "mqtt": {
      "idle_timeout": "12m",
      "max_packet_size": "32MB",
      "retry_interval": "12m",
      "await_rel_timeout": "12m",
      "session_expiry_interval": "12m",
      "mqueue_priorities": {}
    },
    "flapping_detect": {
      "window_time": "12m",
      "ban_time": "12m"
    },
    "force_shutdown": {
      "max_heap_size": "1024KB"
    },
    "conn_congestion": {
      "min_alarm_sustain_duration": "12m"
    },
    "force_gc": {
      "bytes": "32MB"
    }
  }
}

Changes

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