Listeners

Create the specified listener on all nodes.

post/listeners

Request

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

Request body

OR
OR
OR
OR

Example request

{
  "idle_timeout": "32s",
  "handshake_idle_timeout": "32s",
  "keep_alive_interval": "32s",
  "bind": "127.0.0.1:80",
  "limiter": {
    "bytes_in": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB"
    },
    "message_in": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB"
    },
    "connection": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB"
    },
    "message_routing": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB"
    },
    "client": {
      "bytes_in": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      },
      "message_in": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      },
      "connection": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      },
      "message_routing": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      }
    }
  }
}

Response

OR
OR
OR
OR

Example response

{
  "idle_timeout": "32s",
  "handshake_idle_timeout": "32s",
  "keep_alive_interval": "32s",
  "bind": "127.0.0.1:80",
  "limiter": {
    "bytes_in": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB"
    },
    "message_in": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB"
    },
    "connection": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB"
    },
    "message_routing": {
      "rate": "10MB",
      "capacity": "100MB",
      "initial": "0MB"
    },
    "client": {
      "bytes_in": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      },
      "message_in": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      },
      "connection": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      },
      "message_routing": {
        "rate": "10MB",
        "initial": "0MB",
        "low_watermark": "0MB",
        "capacity": "100MB",
        "max_retry_time": "12m",
        "failure_strategy": "force"
      }
    }
  }
}

Changes

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