Compose Database-as-a-Service Help and Documentation

Everything you need to know about Compose, Hosted or Enterprise, is here in our help system. Whether you run one database for your businesses' sole application or six different databases to support an entire corporation, we've got the information you need.

RabbitMQ Management UI, API, and CLI

Compose RabbitMQ deployments have the RabbitMQ management plugin enabled by default, which enables access to your RabbitMQ from a web browser, API, or from the command line. The RabbitMQ Management UI is available from the Browser tab on your deployment.

The URL connection information is also in the Admin UI section of the Connection Info panel of the deployment's Overview .

🚧

Let's Encrypt Certificates

RabbitMQ deployments are signed with Let's Encrypt certificates, but you might encounter a security warning when you first try to open the page. You can check the origin of the certificate using your browser's security settings and add an exception if necessary. You should consult your browser's or your system's documentation on how to do this.

You are next asked to enter your username and password. After you have signed in, you can see an Overview of your RabbitMQ deployment.

You can use any user on your deployment to access the UI, although some features are only available to the users with the "Administrator" tag.

General usage documentation can be found on the RabbitMQ Management Plugin page.

RabbitMQ Management HTTP API

The Management Plugin also provides an API for your RabbitMQ deployment. The base endpoint the same HTTP URL as the browser URL with /api. For example,
https://portal3259-4.judicious-rabbitmq-53.3641604689.composedb.com:32365/api/.

The API uses application/json data and requires basic authentication. You can use any user that you have made on your deployment to access the UI, and the permissions for features is the same as in UI.

Documentation and examples are provided with your deployment at the browser URL with /api/index.html. For example,
`https://portal3259-4.judicious-rabbitmq-53.3641604689.composedb.com:32365/api/index.html

rabbitmqadmin

The rabbitmqadmin binary is available directly from your deployment. The download and installation instructions are found on /cli page of the management plugin. For example,
https://portal3259-4.judicious-rabbitmq-53.3641604689.composedb.com:32365/cli`

📘

rabbitmqadmin versions

rabbitmqadmin is also available with a full, local installation of the RabbitMQ package. However, if the version of the package you download doesn't match the deployment's RabbitMQ version, it might not connect.

Usage example

rabbitmqadmin --username=admin --password=$PASSWORD --ssl --host=portal3259-4.judicious-rabbitmq-53.3641604689.composedb.com --port=32365 list exchanges
  • rabbitmqadmin - The command itself.
  • --username and --password - Authentication for the user that you are using to connect.
  • --ssl - ensures that the connection is TLS/SSL secured.
  • --host= - The parameter that specifies the endpoints where the rabbitmqadmin command connects.
  • --port= - The parameter that specifies the port the RabbitMQ server is listening on.
  • list exchanges - A rabbitmqadmin command to list the database members of the RabbitMQ deployment.

Documentation and other examples for rabbitmqadmin are on the RabbitMQ Management Command-Line Tool page.


Still Need Help?

If this article didn't solve things, summon a human and get some help.

Updated 9 months ago

RabbitMQ Management UI, API, and CLI


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.