Backups for RabbitMQ

General information on backup schedules and downloading your backups can be found on the Backups page. This includes information on restoring a RabbitMQ backup into a new Compose deployment and downloading your backup files.

You may also manage your RabbitMQ backups with the Compose API.

Backup Contents

RabbitMQ backups are a JSON representation of your broker's metadata. This includes users, vhosts, queues, exchanges, and bindings. Backups are made against a running cluster using the export command provided by the RabbitMQ management plugin. Messages are not included in the backup.

More information can be found in the RabbitMQ documentation.

Local Restore

Because you can download and save the metadata from your RabbitMQ broker, you can get your RabbitMQ broker up and running locally. You will need to have a local instance of RabbitMQ running, with the management plug-in included in the RabbitMQ distribution. Enable it with rabbitmq-plugins enable rabbitmq_management. This additionally will get you:

  • the Admin UI at http://localhost:15672/,
  • the HTTP API at http://localhost:15672/api/,
  • and the API's command-line tool rabbitmqadmin at http://localhost:15672/cli/ .

To import the JSON backup file, you can:

  • through the Admin UI at http://localhost:15672/, use the Import/Export definitions function at the bottom of the Overview page.
  • through the API, send a POST to http://server-name:15672/api/definitions. For example:
curl -i -u guest:guest -H "content-type:application/json" -X POST --data @<path_to_your_rabbitmq_backup> http://localhost:15672/api/definitions
  • use the command rabbitmqadmin import <your_rabbitmq_backup>.

Still Need Help?

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