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 Management API

The Management API from HiveMQ — 9 operation(s) for management.

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

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

This API exposes 15 operations across 9 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.

15 operations 9 paths 0 schemas 3 DELETE8 GET4 POST

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 Management 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 15

Across 9 paths, the API surfaces 15 operations — 3 DELETE, 8 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Management 15
GET
/management/backups
List backups
listBackups → 200
POST
/management/backups
Create a backup
createBackup → 201
GET
/management/backups/{backupId}
Get a backup
getBackup 1 param → 200
DELETE
/management/backups/{backupId}
Delete a backup
deleteBackup 1 param → 204
POST
/management/backups/{backupId}/restore
Restore a backup
restoreBackup 1 param → 202
GET
/management/backups/{backupId}/file
Download a backup file
downloadBackup 1 param → 200
GET
/management/diagnostic-archives
List diagnostic archives
listDiagnosticArchives → 200
POST
/management/diagnostic-archives
Create a diagnostic archive
createDiagnosticArchive → 201
GET
/management/diagnostic-archives/{archiveId}
Get a diagnostic archive
getDiagnosticArchive 1 param → 200
DELETE
/management/diagnostic-archives/{archiveId}
Delete a diagnostic archive
deleteDiagnosticArchive 1 param → 204
GET
/management/trace-recordings
List trace recordings
listTraceRecordings → 200
POST
/management/trace-recordings
Start a trace recording
startTraceRecording → 201
GET
/management/trace-recordings/{recordingId}
Get a trace recording
getTraceRecording 1 param → 200
DELETE
/management/trace-recordings/{recordingId}
Stop and delete a trace recording
deleteTraceRecording 1 param → 204
GET
/management/trace-recordings/{recordingId}/file
Download a trace recording file
downloadTraceRecording 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hivemq-management-api-openapi.yml Raw ↑

Other APIs HiveMQ publishes across the network.

HiveMQ MQTT over WebSocket
HiveMQ Data Hub API
HiveMQ Mqtt API