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

RabbitMQ Overview API

The Overview API from RabbitMQ — 2 operation(s) for overview.

RabbitMQ Overview API is one of 14 APIs that RabbitMQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Overview. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 3.13.0.

Requests are made against a single base URL, http://localhost:15672/api.

3 operations 2 paths 1 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.13.0
Base URL
http://localhost:15672/api
Authentication
HTTP Basic
Contact
License
Resource Areas
1

Authentication & Security 1

RabbitMQ Overview API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Overview 3
GET
/overview
Get cluster overview
getOverview → 200
GET
/cluster-name
Get cluster name
getClusterName → 200
PUT
/cluster-name
Set cluster name
setClusterName body → 204

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Overview (9 properties). Each schema is shown below with its type and property counts.

Overview
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rabbitmq-overview-api-openapi.yml Raw ↑

Other APIs RabbitMQ publishes across the network.

RabbitMQ AMQP Messaging API
RabbitMQ Bindings API
RabbitMQ Channels API
RabbitMQ Connections API
RabbitMQ Definitions API
RabbitMQ Exchanges API
RabbitMQ Health API
RabbitMQ Nodes API
RabbitMQ Permissions API
RabbitMQ Policies API
RabbitMQ Queues API
RabbitMQ Users API