HiveMQ Cloud REST API
The HiveMQ Cloud REST API provides an interface for applications to interact programmatically with HiveMQ Cloud.
Our REST API allows applications to send and receive data as JSON (JavaScript Object Notation) objects over standard HTTPS.
HiveMQ Cloud users can leverage the REST API to automate credentials management and numerous actions that they would otherwise perform manually. For example, delete specific MQTT user credentials, attach permissions to a role, and more.
HiveMQ Cloud REST API Endpoints
The endpoints the HiveMQ Cloud REST API offer fulfill many common use cases:
| The HiveMQ Cloud Streaming events API is available for HiveMQ Cloud Enterprise clusters only. For more information about all the plans HiveMQ Cloud offers, contact HiveMQ sales. |
HiveMQ uses the versatile and widely supported OpenAPI Specification to create standard, machine-readable, programming-language agnostic interface descriptions for REST API.
The style of the HiveMQ Cloud REST API focuses on providing scalability and extensibility. The OpenAPI 3.0 schema definition of the REST API can be easily imported into popular API tools such as Postman or used to generate client-code in a wide array of programming languages. For more information, see API Style.
HiveMQ Cloud REST API Authorization Tokens
The use of the HiveMQ Cloud REST API requires a JWT token (JSON Web Token). You can create the necessary API token from the console of your HiveMQ Cloud cluster. Tokens can apply to all clusters in your account or to a specific cluster.
The API token grants programmatic access to the HiveMQ Cloud API to manage MQTT permissions, MQTT roles, and MQTT credentials. For more information, see HiveMQ Cloud API Tokens.
For more information on the available API endpoints and their request and response objects, see HiveMQ Cloud REST Specification.
| The HiveQ Cloud REST API is currently available for use with the HiveMQ Cloud Starter plan only. |