Skip to content
IndraMQTT

Reference

Reference

flowchart LR
    Set["settings"] -- "load" --> Kernel["kernel"]
    Kernel -- "serve" --> API["/api/v1 + /api/v5"]
    API -- "show" --> Schema["config-schema.json"]
  • Settings reference: each startup setting with its type, default and valid range. The file is generated. Do not edit it by hand.
  • Configuration layers: Configuration.
  • Native API (/api/v1): users, access rules, tenants, metrics and the console.
  • Reference management API (/api/v5): the compatible surface for nodes, clients, rules and metrics. It follows the reference management API.
  • schemas/config-schema.json: the machine-readable schema.

Check that it works

Start the broker with this file. The health endpoint returns OK.

[node]
id = "docs-reference"


[listeners.tcp]
bind = "0.0.0.0:1883"


[listeners.api]
bind = "0.0.0.0:18083"


[logging]
level = "warn"
Terminal window
python3 - <<'PY'
import os, socket
port = int(os.environ.get("API_PORT", "18083"))
sock = socket.create_connection(("127.0.0.1", port), timeout=5)
sock.sendall(b"GET /healthz HTTP/1.0\r\nHost: docs\r\n\r\n")
print(sock.makefile().read().strip().splitlines()[-1])
PY
OK