Industrial IoT / SCADA · API

EMQX REST API

EMQ

Administer MQTT broker resources through documented REST endpoints.

Official documentation Download development spec

EMQX / DEVELOPER FIELD GUIDE

Choose an interface. Define a verifiable result.

Company or project context, ten technical entry points and a practical analysis of every reference.

2026-10-08 · Integration not tested

Company / project overview

Original summary of official company or project statements; use the source for the full original page.

EMQX · About
Company and project	EMQ develops MQTT-based connectivity and real-time data infrastructure; EMQX is its broker platform.
Edition and version	These current Enterprise documentation entrypoints require matching deployed version, licensed features and feature gates; they are not ten separate SDKs.

Complete official About page ↗

About reference — TA analysis
Audience	Buyers, partners and product owners shortlisting an AI provider.
Our assessment	Use positioning and company history for initial fit. Obtain project-specific deployment, support and commercial terms separately.

Official sources reviewed. No provider API or inference was run; results are illustrative internal contracts.

Top 10 technical entry points

Ten documented technical entry points selected for implementation decisions, not ten independent SDKs or an official ranking.

Choose by the work you need to complete
Interface	Purpose and audience
01 · REST API and OpenAPIAPI / SDK / developer guide	Inspect deployment API schema and automate broker management.Automation developers
02 · Client/session inspectionAPI / SDK / developer guide	Inspect connections and unexpired sessions.Operations engineers
03 · Subscription inspectionAPI / SDK / developer guide	Inspect client/topic/QoS and MQTT5 subscription options.MQTT integrators
04 · Retained message managementAPI / SDK / developer guide	Inspect stored retained topic payloads.Device-state consumers
05 · MQTT authenticationAPI / SDK / developer guide	Verify client identities through configured authenticators.Device security developers
06 · MQTT authorizationAPI / SDK / developer guide	Control publish/subscribe operations by client and topic.Tenant isolation teams
07 · Rules and actionsAPI / SDK / developer guide	Transform/filter data with SQL-like rules and actions.Pipeline developers
08 · Prometheus metricsAPI / SDK / developer guide	Collect runtime metrics with pull or push integration.SRE teams
09 · Filtered log traceAPI / SDK / developer guide	Trace selected clients, topics, IPs or rules.Troubleshooting engineers
10 · gRPC hook extensionAPI / SDK / developer guide	Handle broker events in an external language service.Extension developers

Reference analysis

Capabilities summarize official documentation. Constraints and proposed tests are our engineering assessment.

API / SDK / developer guide

REST API and OpenAPI

REST API and OpenAPI · TA
Target audience	Automation developers
Documented capability	Inspect deployment API schema and automate broker management.
Input → output	Versioned management request → JSON/status.
Execution environment	API key/secret or bearer token; deployed feature set.
Our decision constraint	6.3 removes bundled Swagger UI; disabled features omit their API paths.
Our suggested validation	Read installed schema; do not use Dashboard password as API Basic credentials.

Official reference · REST API and OpenAPI ↗

API / SDK / developer guide

Client/session inspection

Client/session inspection · TA
Target audience	Operations engineers
Documented capability	Inspect connections and unexpired sessions.
Input → output	Client filters → connection/session details.
Execution environment	Authorized Dashboard or matching deployment API.
Our decision constraint	A retained session does not mean its client is online.
Our suggested validation	Check connection state and full pagination before counting clients.

Official reference · Client/session inspection ↗

API / SDK / developer guide

Subscription inspection

Subscription inspection · TA
Target audience	MQTT integrators
Documented capability	Inspect client/topic/QoS and MQTT5 subscription options.
Input → output	Client/topic query → subscriptions.
Execution environment	Matching broker version and client MQTT version.
Our decision constraint	Subscription existence is not proof of application receipt.
Our suggested validation	Validate No Local and retained-message handling against requirements.

Official reference · Subscription inspection ↗

API / SDK / developer guide

Retained message management

Retained message management · TA
Target audience	Device-state consumers
Documented capability	Inspect stored retained topic payloads.
Input → output	Topic selection → payload, QoS and publication time.
Execution environment	Retainer configuration and management access.
Our decision constraint	Retained data may be stale; it is not a full message history.
Our suggested validation	Check publication time and expiry policy before displaying live state.

Official reference · Retained message management ↗

API / SDK / developer guide

MQTT authentication

MQTT authentication · TA
Target audience	Device security developers
Documented capability	Verify client identities through configured authenticators.
Input → output	Client credentials → authentication result.
Execution environment	Configured certificate/password/JWT or supported mechanism.
Our decision constraint	Do not assume authentication is enabled by default.
Our suggested validation	Verify valid credentials and explicitly denied invalid clients.

Official reference · MQTT authentication ↗

API / SDK / developer guide

MQTT authorization

MQTT authorization · TA
Target audience	Tenant isolation teams
Documented capability	Control publish/subscribe operations by client and topic.
Input → output	Identity/topic/operation → allow or deny.
Execution environment	Configured permission sources and applicable cache behavior.
Our decision constraint	Authentication success does not grant every topic.
Our suggested validation	Check cross-tenant topics, QoS and retained-message permissions.

Official reference · MQTT authorization ↗

API / SDK / developer guide

Rules and actions

Rules and actions · TA
Target audience	Pipeline developers
Documented capability	Transform/filter data with SQL-like rules and actions.
Input → output	Message event and rule → action or republished output.
Execution environment	Enabled rule engine and configured connectors/actions.
Our decision constraint	A rule match does not prove destination commit.
Our suggested validation	Verify transformed payload and sink result separately.

Official reference · Rules and actions ↗

API / SDK / developer guide

Prometheus metrics

Prometheus metrics · TA
Target audience	SRE teams
Documented capability	Collect runtime metrics with pull or push integration.
Input → output	Configured collection → metric time series.
Execution environment	Metrics feature gate and dashboard dependency in 6.3.
Our decision constraint	Push mode is not identical to the full pull metric set.
Our suggested validation	Check metric availability and sample freshness on target release.

Official reference · Prometheus metrics ↗

API / SDK / developer guide

Filtered log trace

Filtered log trace · TA
Target audience	Troubleshooting engineers
Documented capability	Trace selected clients, topics, IPs or rules.
Input → output	Trace filter → matching diagnostic events.
Execution environment	Authorized tracing and bounded retention.
Our decision constraint	No matching events can mean an incorrect filter or idle traffic.
Our suggested validation	Use a known event to validate trace coverage; redact sensitive payloads.

Official reference · Filtered log trace ↗

API / SDK / developer guide

gRPC hook extension

gRPC hook extension · TA
Target audience	Extension developers
Documented capability	Handle broker events in an external language service.
Input → output	EMQX hook → gRPC server callback response.
Execution environment	Exhook configuration and compatible callback schema.
Our decision constraint	External service behavior becomes a dependency for configured hooks.
Our suggested validation	Test handler outage, timeout and chained callback behavior.

Official reference · gRPC hook extension ↗

Official documentation

Official documentation · Supporting reference analysis
TA	Developers and technical product owners
Our validation advice	Pin the release and follow the target-specific support requirements before implementation.

Official reference · Official documentation ↗

04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE

Expected results before implementation

Illustrative broker observation contract; no broker, MQTT traffic or management API was used.

Illustrative contract · no API call or model execution · not measured provider output

Correlated delivery

Expected behavior — illustrative, not executed
Input	Synthetic event with known client and topic.
Expected result	Broker event and consumer event share application event ID.
Acceptance	Do not substitute connected=true for delivery evidence.

No clients match

Expected behavior — illustrative, not executed
Input	Authorized filtered query with no matching active clients.
Expected result	clients=[] with query scope preserved.
Acceptance	Distinguish empty filtered results from complete broker outage.

Expired management credential

Expected behavior — illustrative, not executed
Input	REST request with expired bearer token.
Expected result	Authentication error; no management result.
Acceptance	Renew through authorized flow without logging secrets.

Feature API unavailable

Expected behavior — illustrative, not executed
Input	Call targets a path disabled by the installed feature set.
Expected result	Unsupported/disabled feature classification; not empty success.
Acceptance	Compare installed API schema and feature set before changing integrations.

Map the expected result to your application

Map your actual runtime response into this proposed application contract. All values are invented examples; no credentials or live execution are included.

Expected output JSON — illustrative, not measured · EMQXAPI-expected-results.json

{
  "schema_version": "1.0.0",
  "example": true,
  "provider": "EMQX",
  "status": "ok",
  "input_id": "sample-001",
  "data": {
    "client_id": "demo-client-001",
    "connected": true,
    "topic": "demo/telemetry",
    "consumer_observed": true,
    "retained_payload_is_live": false
  },
  "error": null,
  "verification": "illustrative-only;not-provider-response"
}

Download specification, example and acceptance plan

Engineering handoff — our proposed contract and gates
State semantics	Valid empty results differ from errors. Pending work must not appear successful before completion.
Evidence	Record service and SDK versions, request identity, configuration and response mapping. No execution or performance was measured here.
Acceptance proposal	Agree numerical tolerances and workload targets before testing on representative authorized samples.

Development assessment

MQTT fleet health view

Development concept · integration not tested

Provider capabilities above are based on official documentation or repositories. The proposed product, inputs, deliverable and acceptance criteria below are our development assessment.

Small prototype

Test one documented operation with a small real sample after access is confirmed. This is a development judgment, not a delivery estimate.

Proposed inputs: A test device or simulator, a tag map and documented units.
Proposed deliverable: Timestamped device values with freshness, unit and connection state.
Acceptance criterion: Verify scaling and timestamps against the source; a disconnected device must not appear healthy.
Dependencies: A gateway or service account, an equipment schema and access to a test environment.

Development sequence

Confirm access to EMQX REST API, license and the exact supported version.
Prepare the sample above and implement one documented operation for “MQTT fleet health view”.
Normalize the result with source, time and explicit error state; keep the provider response for review.
Run the acceptance criterion before estimating rollout effort or committing a customer deliverable.

How to validate demand

Record product views, documentation clicks, specification downloads and contextual hub clicks. These are event counts, not unique people or completed integrations.

This feasibility assessment uses implementation conditions. No traffic-based rank or delivery-time promise is assigned.

EMQX REST API

Choose an interface. Define a verifiable result.

Company / project overview

Top 10 technical entry points

Reference analysis

Official documentation

Expected results before implementation

Correlated delivery

No clients match

Expired management credential

Feature API unavailable

Map the expected result to your application

MQTT fleet health view

Development sequence

How to validate demand

Related products