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

The Definitions API from RabbitMQ — 1 operation(s) for definitions.

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

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

This API exposes 2 operations across 1 path, and defines 8 schemas. 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.

2 operations 1 paths 8 schemas 1 GET1 POST

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 Definitions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Definitions 2
GET
/definitions
Export definitions
getDefinitions → 200
POST
/definitions
Import definitions
postDefinitions body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Queue (13 properties), Definitions (8 properties), Vhost (7 properties), Exchange (7 properties). Each schema is shown below with its type and property counts.

User
object
4 properties
Policy
object
6 properties
Binding
object
7 properties
Definitions
object
8 properties
Exchange
object
7 properties
Queue
object
13 properties
Vhost
object
7 properties
Permission
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rabbitmq-definitions-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 Exchanges API
RabbitMQ Health API
RabbitMQ Nodes API
RabbitMQ Overview API
RabbitMQ Permissions API
RabbitMQ Policies API
RabbitMQ Queues API
RabbitMQ Users API