Listeners

List all running node's listeners for the specified type.

get/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)

Query parameters

type'tcp' | 'ssl' | 'ws' | 'wss' | 'quic'

Listener type

Response

idstring required

Listener id

type'tcp' | 'ssl' | 'ws' | 'wss' | 'quic' required

Listener type

namestring required

Listener name

enableboolean required

Listener enable

numberinteger

ListenerId counter

bindstring required

Listener bind addr

acceptorsinteger

ListenerId acceptors

Example response

[
  {
    "id": "tcp:demo",
    "bind": "127.0.0.1:80",
    "node_status": [
      {
        "node": "emqx@127.0.0.1"
      }
    ]
  }
]

Changes

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