Skip to content

EMQX Enterprise

Main Navigationemqx.com

English

简体中文

English

Appearance

Sidebar Navigation

EMQX Overview

What's New

Feature Comparison

Get Started

Operating Limitations

FAQ

Concept FAQs

Deployment FAQs

Feature FAQs

Usage FAQs

Technical Support

Installation and Deployment

Installation Guide

Docker

Debian

Ubuntu

CentOS/RHEL

macOS

Kubernetes

EMQX Operator

Install Operator and Deploy EMQX

Deploy EMQX on AWS

Deploy EMQX on Google cloud

Deploy EMQX on Azure

Manage EMQX Cluster

Manage License

Enable TLS for Listeners

Change EMQX Configuration

Enable Core-Replicant Deployment

Enable Persistence

Access EMQX Cluster through LoadBalancer

Perform Blue-Green Upgrade

Collect EMQX Logs

Change EMQX Log Level

Monitor EMQX Cluster

Rebalance Cluster Load

Deploy EMQX Cluster in k8s with Restricted Access

API Reference

API Reference (v2)

API Reference (v2beta1)

EMQX Helm Chart

Work with License

Upgrade Guide

Rolling Upgrade

Upgrade EMQX Cluster from 4.4 to 5.x

Upgrade EMQX on Kubernetes

Developer Guide

Publish/Subscribe

MQTT Core Concepts

Test with MQTT Clients

MQTT Shared Subscription

MQTT Retained Message

MQTT Will Message

Exclusive Subscription

Delayed Publish

Auto Subscribe

Topic Rewrite

Wildcard Subscription

MQTT Durable Sessions

Client SDK

Connect via C SDK

Connect via Java SDK

Connect via Go SDK

Connect via Python SDK

Connect via JavaScript SDK

REST API

EMQX Enterprise API Docs

EMQX Clustering

Cluster Architecture

Create and Manage Cluster

Cluster Security

Configure Load Balancer

Load Balance EMQX Cluster with NGINX

Load Balance EMQX Cluster with HAProxy

Node Evacuation and Cluster Load Rebalancing

Performance and Tuning

Performance Tuning (Linux)

Performance Test with eMQTT-Bench

Test Scenarios and Results for Reference

Security Guide

Network and TLS

Enable SSL/TLS Connection

Client TLS Connection Code Examples

Obtain SSL/TLS Certificates

CRL Check

OCSP Stapling

Authentication

X.509 Certificate Authentication

JWT Authentication

Password-Based Authentication

Use Built-in Database

Integrate with MySQL

Integrate with MongoDB

Integrate with PostgreSQL

Integrate with Redis

Integrate with LDAP

Use HTTP Service

MQTT 5.0 Enhanced Authentication - SCRAM

REST API-Based MQTT 5.0 SCRAM Authentication

MQTT 5.0 Enhanced Authentication - Kerberos

Client-Info Authentication

PSK Authentication

Use HTTP API to Manage User Data

Access Control List

Authorization

Use ACL File

Use Built-in Database

Integrate with MySQL

Integrate with MongoDB

Integrate with PostgreSQL

Integrate with Redis

Integrate with LDAP

Use HTTP Service

Banned Clients

Flapping Detect

Rule Engine

Create Rules

Rule SQL Reference

Data Sources and Fields

Built-in SQL Functions

jq Functions

Smart Data Hub

Schema Registry

Schema Registry Example - Avro

Schema Registry Example - Protobuf

Schema Registry Example - External HTTP Server

Sparkplug B

Schema Validation

Message Transformation

Flow Designer

LLM-Based MQTT Data Processing

Quick Start: Create a Flow Using OpenAI Node

Quick Start: Create a Flow Using Anthropic Node

Quick Start: Create a Flow Using Gemini Node

Data Integration

Connector

Webhook

AlloyDB

Apache Doris

Apache Kafka

Apache IoTDB

Apache Pulsar

AWS Kinesis

AWS Redshift

AWS S3

AWS S3 Tables

AWS Timestream

Azure Blob Storage

Azure Event Hubs

BigQuery

Cassandra

ClickHouse

CockroachDB

Confluent

Couchbase

Datalayers

Disk Log

DynamoDB

Elasticsearch

EMQX Tables

GCP PubSub

GreptimeDB

HTTP Server

InfluxDB

Lindorm

Microsoft SQL Server

MongoDB

MQTT

MySQL

OpenTSDB

Oracle Database

PostgreSQL

RabbitMQ

Redis

RocketMQ

Snowflake

SysKeeper

Tablestore

TDengine

TimescaleDB

Administration Guide

Configuration Files

Cluster

Listener

MQTT

Flapping Detection

Limiter

Logs

Prometheus

Dashboard

License

EMQX Enterprise Configuration Manual

Command Line Interface

MQTT Durable Sessions

Configure and Manage Durable Sessions

Manage Data Replicas

EMQX Dashboard

Dashboard Home Page

Monitoring

Clients

Subscription Management

Retained Messages

Namespace

Delayed Publish

Alarms

Access Control

Authentication

Authorization

Integration

Rules

Smart Data Hub

Management

Cluster Settings

Advanced MQTT

Extensions

Diagnose

System

Single Sign-On (SSO)

Configure OpenLDAP and Microsoft Entra ID SSO

Configure SAML-Based SSO

Configure OIDC-Based SSO

Multi-Factor Authentication (MFA)

Audit Log

Rate Limit

Namespace

Create Namespaces

Configure and Manage Namespaces

Global Namespace Settings

Quick Start: Experience Namespaces

Logs and Observability

Statistics and Metrics

Alarm

Logs

Topic Metrics

Slow Subscriptions

Log Trace

System Topic

Integrate with Prometheus

Integrate with Datadog

Integrate with OpenTelemetry

Integrate OpenTelemetry to View Metrics

Integrate OpenTelemetry for Log Management

Integrate OpenTelemetry Tracing

End-to-end Traces

End-to-End Tracing Span Details

Backup and Restore

Plugin and Extension

Hooks

Plugins

Develop EMQX Plugins

Customize Plugin Logic

Manage Plugins

gRPC Hook Extension

Telemetry

Advanced Features

Message Queue

Message Queue User Guide

Message Queue Quick Start

MQTT Streams

MQTT Streams User Guide

MQTT Streams Quick Start

MQTT over QUIC

Features and Benefits

Use MQTT over QUIC

Cluster Linking

Cluster Linking Quick Start

Cluster Linking User Guide

File Transfer over MQTT

Quick Start with MQTT File Transfer

Configure File Transfer Server-Side Settings

File Transfer Clients Development

Multi-Protocol Gateway

STOMP Gateway

MQTT-SN Gateway

CoAP Gateway

LwM2M Gateway

ExProto Gateway

OCPP Gateway

JT/T 808 Gateway

JT/T 808 Gateway Data Exchange Format

NATS Protocol Gateway

GB/T 32960 Gateway

MQTT Client Attributes

EMQX AI

MCP over MQTT

Architecture

Specification

SDKs

Erlang SDK

ESP32 C SDK

C SDK with Paho MQTT

Python SDK

TypeScript SDK

Kotlin SDK

MCP Bridge

Quick Start

Realtime Audio & Video AI

Build a Real-Time Voice Agent with EMQX + Volcano Engine RTC

RTC Services

Volcengine RTC

Installation and Testing

API Reference

Scenarios

Pure Voice Conversation

Voice-Controlled Hardware

Device-Initiated Voice Feedback

GPT-Realtime

Build Real-Time Voice Agent

Migration Guide

AWS IoT Core

Azure IoT Hub

HiveMQ

Mosquitto

Tutorials

MQTT Programming

EMQX Essentials

MQTT Guide

MQTT Basics

MQTT Advanced

Design and Implementation

EMQX Clustering

In-flight and Message Queue

Message Retransmission

Durable Storage

Reference

MQTT 5.0 Specification

MQTT 3.1.1 Specification

MQTT Glossary

MQTT 5.0 Features

MQTT Reason Code

Release Notes

EMQX Enterprise Version 6

EMQX Enterprise Version 5

EMQX Enterprise Version 4

Known Issues

Known Issues in EMQX 6.0

Known Issues in EMQX 5.9

Known Issues in EMQX 5.8

Known Issues in EMQX 5.3

Known Issues in EMQX 5.1

Incompatible Changes

Incompatible Changes in EMQX 6.0

Incompatible Changes in EMQX 5.10

Incompatible Changes in EMQX 5.9

Incompatible Changes in EMQX 5.8

Incompatible Changes in EMQX 5.7

Incompatible Changes in EMQX 5.6

Incompatible Changes in EMQX 5.5

Incompatible Changes in EMQX 5.4

Incompatible Changes between EMQX 5.x and EMQX 6.0

Incompatible Changes between EMQX 4.4 and EMQX 5.1

Authentication / Authorization Incompatibility Between EMQX 4.4 and EMQX 5.1

Data Integration Incompatibility Between EMQX 5.1 and EMQX 4.4

Gateway Incompatibility Between EMQX 4.4 and EMQX 5.1

End of Life Dates

On this page

Table of Contents for current page

API Reference

apps.emqx.io/v2
apps.emqx.io/v2beta1 (partially deprecated)

Previous pageDeploy EMQX Cluster in k8s with Restricted Access

Next pageAPI Reference (v2)

Kubernetes

EMQX Operator

Manage EMQX Cluster

API Reference

Password-Based Authentication

Monitoring

Access Control

Integration

Management

Integrate with OpenTelemetry

End-to-end Traces

Plugins

JT/T 808 Gateway

Volcengine RTC

Scenarios

GPT-Realtime

API Reference ​

API Reference