HiveMQ Management API

openapi: 3.1.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.

        '