Menu Search
Chapter 6. Management Channels
Prev   Next

Chapter 6. Management Channels

Table of Contents

6.1. HTTP Management
6.1.1. Introduction
6.1.2. Default Configuration
6.2. Web Management Console
6.2.1. Accessing the Console
6.2.2. Orientation
6.2.3. Managing Entities
6.3. REST API
6.3.1. Introduction
6.3.2. REST API documentation
6.3.3. Authentication
6.3.4. Configured Object creation
6.3.5. Configured Object update
6.3.6. Configured Object deletion
6.3.7. Retrieving Configured Object details
6.3.8. Configured Object operations
6.3.9. HTTP status codes returned by REST interfaces
6.3.10. Examples of REST requests with curl
6.3.11. Query API
6.3.12. Query Engine
6.3.13. Cross Origin Resource Sharing (CORS)
6.4. Prometheus Metrics
6.5. AMQP Intrinstic Management

The Broker can be managed over a number of different channels.

  • HTTP - The primary channel for management. The HTTP interface comprises a Web Console and a REST API.

  • AMQP - The AMQP protocols 0-8..0-10 allow for some management of Exchanges, Queue and Bindings. This will be superseded by AMQP 1.0 Management. It is suggested that new users favour the Management facilities provided by the Web Console/REST API.

6.1. HTTP Management

6.1.1. Introduction

The HTTP Management plugin provides a HTTP based API for monitoring and control of the Broker. The plugin actually provides two interfaces:

  • Web Management Console - rich web based interface for the management of the Broker.

  • REST API - REST API providing complete programmatic management of the Broker.

The Web Management Console itself uses the REST API, so every function you can perform through the Web Management Console can be also be scripted and integrated into other systems. This provides a simple integration point allowing the Broker to monitored and controlled from systems such as Naoios or BMC Control-M.

6.1.2. Default Configuration

By default, the Broker is shipped with HTTP enabled running port 8080. The HTTP plugin is configured to require SASL authentication. The port is not SSL protected.

The settings can be changed by configuring the HTTP plugin and/or the port configured to serve HTTP.

Prev   Next
5.8. Virtualhost Initial Configuration Home 6.2. Web Management Console

Apache Qpid, Messaging built on AMQP; Copyright © 2015 The Apache Software Foundation; Licensed under the Apache License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, Proton, Apache, the Apache feather logo, and the Apache Qpid project logo are trademarks of The Apache Software Foundation; All other marks mentioned may be trademarks or registered trademarks of their respective owners