MQTT API and REST API

MQTT API and REST API

Maximize system administration in your IoT setup with a powerful set of REST and MQTT APIs.

How MQTT and REST APIs work

Pro Mosquitto MQTT APIs

Pro Mosquitto MQTT APIs

Pro Mosquitto provides a set of MQTT APIs available via MQTT and can be used with an MQTT client, including third-party clients.

MQTT APIs functionality

Dynamic Security MQTT API allows creating MQTT clients, adding new Mosquitto users, managing their access rights, grouping them, etc. Moreover, it provides endpoints to return status data and enables active DynSec Plugin management. Learn more here.

High Availability MQTT API handles cluster management, including viewing cluster details, testing its health status, creating and deleting a cluster, adding or removing a node within a cluster, and more. Learn more here.

Inspect MQTT API gives an overview of connected and disconnected MQTT clients, including details like data transmission statistics, SSL certificates connect/disconnect timestamps, and an overview of topics to which every MQTT client is subscribed. Learn more here.

Certificate Management MQTT API manages Certificate Authorities (CAs) for client certificate based authentication. Learn more here.

Client Control MQTT API allows users to execute different commands to connected clients (e.g. disconnect a client), through the plugin’s control API. Learn more here.

The Streams REST API enables you to manage data streams on the MQTT broker, with functionalities to create, update, and replay streams. Learn more here.

Topic Tree MQTT API provides information on topics the broker is actively using, including both published messages and subscriptions. Learn more here.

REST APIs

REST APIs

The Cedalo MQTT Platform offers a set of REST APIs for managing the Platform while exposing MQTT APIs functionality to HTTP clients..

REST APIs functionality

The Projects REST API enables monitoring and inspection of all projects within the Cedalo MQTT Platform. Learn more here.

The Users REST API helps you manage and organize users. Learn more here.

The Brokers REST API provides access and control over MQTT broker instances by fetching connection and license data. Learn more here.

The Clusters REST API provides comprehensive information and management capabilities for Mosquitto broker clusters, enabling the efficient management of high availability broker setups. Learn more here.

The Topic Tree REST API provides information about the broker’s topic tree. It displays MQTT topics in a hierarchical structure, giving you a clear overview of the topics a broker uses.

The Client Control REST API allows you to monitor and manage client connections by offering capabilities to subscribe/unsubscribe clients from given topics or disconnect them entirely from the broker. Learn more here.

The Client Inspect REST API retrieves detailed diagnostic information about connected clients. Learn more here.

The Application Tokens REST API allows you to create, retrieve, and revoke tokens with role-based access and expiration dates. Learn more here.

The Access Control REST API manages the dynamic security feature to ensure secure access control, enabling the management of MQTT clients, roles, and groups. Learn more here.

The Streams REST API enables you to manage data streams on the MQTT broker, with functionalities to create, update, and replay streams. Learn more here.

REST APIs functionality

The Cluster Management REST API provides detailed information about Mosquitto clusters, e.g., which clusters the Management Center is connected to and which Mosquitto nodes belong to which cluster.

The Topic Tree REST API lets you retrieve information about the topic tree and clear its cache. It displays MQTT topics in a hierarchical structure, giving you a clear overview of the topics a broker uses. It also helps monitor which MQTT topics are used and how many messages are sent through each topic, etc.

The User Management REST API allows you to automatically create, read, update and delete Management Center users and groups, and manage their roles. Learn more here.

The Connection REST API provides a capability to manage (create and delete) Pro Mosquitto nodes connections to the Management Center.

The Monitoring REST API provides insights into the health of Pro Mosquitto HA clusters, leveraging data from Pro Mosquitto broker instances. Learn more here.

The Dynamic Security REST API enables you to manage MQTT clients, groups, and ACL access rights. Learn more here.

The Application Tokens REST API securely uses the Management Center’s REST APIs to create application tokens with role-based access and expiration dates. Users can automate actions handled via the UI. For instance, if an IoT platform provider receives a new booking for a service, its ERP system can automatically assign correct access rights for the new customer’s IoT device on Pro Mosquitto broker nodes. Learn more here.

Back to top