HiveMQ

HiveMQ Management API

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

Documentation GitHub OpenAPI

Operations 15

GET /management/backups List backups #

POST /management/backups Create a backup #

GET /management/backups/{backupId} Get a backup #

DELETE /management/backups/{backupId} Delete a backup #

POST /management/backups/{backupId}/restore Restore a backup #

GET /management/backups/{backupId}/file Download a backup file #

GET /management/diagnostic-archives List diagnostic archives #

POST /management/diagnostic-archives Create a diagnostic archive #

GET /management/diagnostic-archives/{archiveId} Get a diagnostic archive #

DELETE /management/diagnostic-archives/{archiveId} Delete a diagnostic archive #

GET /management/trace-recordings List trace recordings #

POST /management/trace-recordings Start a trace recording #

GET /management/trace-recordings/{recordingId} Get a trace recording #

DELETE /management/trace-recordings/{recordingId} Stop and delete a trace recording #

GET /management/trace-recordings/{recordingId}/file Download a trace recording file #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hivemq-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: HiveMQ REST Data Hub Management API
  description: 'REST API for administering a HiveMQ broker. Endpoints cover MQTT

    client listing, search, disconnect; session invalidation; backups;

    diagnostic archives; trace recordings; and Data Hub schemas, policies,

    and modules. Endpoint shapes inferred from the public HiveMQ REST API

    documentation at docs.hivemq.com/hivemq/latest/rest-api/.

    '
  version: '1.0'
  contact:
    name: HiveMQ Documentation
    url: https://docs.hivemq.com/hivemq/latest/rest-api/index.html
servers:
- url: http://127.0.0.1:8888/api/v1
  description: Default HiveMQ REST API listener
security:
- BearerAuth: []
tags:
- name: Management
paths:
  /management/backups:
    get:
      summary: List backups
      operationId: listBackups
      responses:
        '200':
          description: OK
      tags:
      - Management
    post:
      summary: Create a backup
      operationId: createBackup
      responses:
        '201':
          description: Created
      tags:
      - Management
  /management/backups/{backupId}:
    parameters:
    - name: backupId
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get a backup
      operationId: getBackup
      responses:
        '200':
          description: OK
      tags:
      - Management
    delete:
      summary: Delete a backup
      operationId: deleteBackup
      responses:
        '204':
          description: Deleted
      tags:
      - Management
  /management/backups/{backupId}/restore:
    parameters:
    - name: backupId
      in: path
      required: true
      schema:
        type: string
    post:
      summary: Restore a backup
      operationId: restoreBackup
      responses:
        '202':
          description: Accepted
      tags:
      - Management
  /management/backups/{backupId}/file:
    parameters:
    - name: backupId
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Download a backup file
      operationId: downloadBackup
      responses:
        '200':
          description: OK
      tags:
      - Management
  /management/diagnostic-archives:
    get:
      summary: List diagnostic archives
      operationId: listDiagnosticArchives
      responses:
        '200':
          description: OK
      tags:
      - Management
    post:
      summary: Create a diagnostic archive
      operationId: createDiagnosticArchive
      responses:
        '201':
          description: Created
      tags:
      - Management
  /management/diagnostic-archives/{archiveId}:
    parameters:
    - name: archiveId
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get a diagnostic archive
      operationId: getDiagnosticArchive
      responses:
        '200':
          description: OK
      tags:
      - Management
    delete:
      summary: Delete a diagnostic archive
      operationId: deleteDiagnosticArchive
      responses:
        '204':
          description: Deleted
      tags:
      - Management
  /management/trace-recordings:
    get:
      summary: List trace recordings
      operationId: listTraceRecordings
      responses:
        '200':
          description: OK
      tags:
      - Management
    post:
      summary: Start a trace recording
      operationId: startTraceRecording
      responses:
        '201':
          description: Created
      tags:
      - Management
  /management/trace-recordings/{recordingId}:
    parameters:
    - name: recordingId
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get a trace recording
      operationId: getTraceRecording
      responses:
        '200':
          description: OK
      tags:
      - Management
    delete:
      summary: Stop and delete a trace recording
      operationId: deleteTraceRecording
      responses:
        '204':
          description: Deleted
      tags:
      - Management
  /management/trace-recordings/{recordingId}/file:
    parameters:
    - name: recordingId
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Download a trace recording file
      operationId: downloadTraceRecording
      responses:
        '200':
          description: OK
      tags:
      - Management
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Authentication is disabled by default. When enabled via the

        HiveMQ Enterprise Security Extension or Enterprise Extension SDK

        REST Service, a bearer token is required.

        '