openapi: 3.1.0
info:
  title: RabbitMQ Management HTTP Bindings Overview API
  description: The RabbitMQ Management Plugin provides an HTTP-based API for management and monitoring of RabbitMQ nodes and clusters. It allows management of exchanges, queues, bindings, virtual hosts, users, permissions, policies, and more.
  version: 3.13.0
  contact:
    name: RabbitMQ
    url: https://www.rabbitmq.com/
  license:
    name: MPL 2.0
    url: https://www.mozilla.org/en-US/MPL/2.0/
servers:
- url: http://localhost:15672/api
  description: Default RabbitMQ Management API
security:
- basicAuth: []
tags:
- name: Overview
paths:
  /overview:
    get:
      summary: Get cluster overview
      operationId: getOverview
      tags:
      - Overview
      responses:
        '200':
          description: Cluster overview including message rates and queue totals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Overview'
  /cluster-name:
    get:
      summary: Get cluster name
      operationId: getClusterName
      tags:
      - Overview
      responses:
        '200':
          description: Cluster name
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
    put:
      summary: Set cluster name
      operationId: setClusterName
      tags:
      - Overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
      responses:
        '204':
          description: Cluster name updated
components:
  schemas:
    Overview:
      type: object
      properties:
        management_version:
          type: string
        rates_mode:
          type: string
        exchange_types:
          type: array
          items:
            type: object
        rabbitmq_version:
          type: string
        cluster_name:
          type: string
        erlang_version:
          type: string
        queue_totals:
          type: object
          properties:
            messages:
              type: integer
            messages_ready:
              type: integer
            messages_unacknowledged:
              type: integer
        message_stats:
          type: object
          properties:
            publish:
              type: integer
            deliver_get:
              type: integer
            ack:
              type: integer
        node:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic