Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HiveMQ Mqtt API

The Mqtt API from HiveMQ — 5 operation(s) for mqtt.

HiveMQ Mqtt API is one of 4 APIs that HiveMQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Mqtt. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, http://127.0.0.1:8888/api/v1.

6 operations 5 paths 0 schemas 2 DELETE4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
http://127.0.0.1:8888
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

HiveMQ Mqtt API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Authentication is disabled by default. When enabled via the HiveMQ Enterprise Security Extension or Enterprise Extension SDK REST Service, a bearer token is re…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 DELETE, 4 GET. Each is listed below with its method, path, parameters, and response codes.

Mqtt 6
GET
/mqtt/clients
List MQTT clients
listMqttClients → 200
GET
/mqtt/clients/{clientId}
Get details for a specific MQTT client
getMqttClient 1 param → 200
DELETE
/mqtt/clients/{clientId}
Disconnect an MQTT client
disconnectMqttClient 1 param → 204
GET
/mqtt/clients/{clientId}/connection
Get connection status of an MQTT client
getMqttClientConnection 1 param → 200
GET
/mqtt/clients/{clientId}/subscriptions
List subscriptions for a client
listMqttClientSubscriptions 1 param → 200
DELETE
/mqtt/clients/{clientId}/session
Invalidate the client session
invalidateMqttClientSession 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hivemq-mqtt-api-openapi.yml Raw ↑

Other APIs HiveMQ publishes across the network.

HiveMQ MQTT over WebSocket
HiveMQ Data Hub API
HiveMQ Management API