Plugins

Install community plugin

Changed on

Installs and enables a RabbitMQ community plugin. When async=true the operation returns immediately with a job_id. Track progress using the Jobs API.

post/plugins/community

Request

  • Base URL
    https://api.cloudamqp.com/api
  • URL
    https://api.cloudamqp.com/api/plugins/community
  • Auth
    HTTP basic

Query parameters

asyncboolean

Asynchronous API mode - request returns immediately and plugin is installed in background

Request body application/x-www-form-urlencoded

plugin_namestring required

The name of the community plugin to install

Example request

{
  "plugin_name": "rabbitmq_management_themes"
}

Response

Community plugin install started asynchronously

job_idstring uuid

Job ID to track the asynchronous operation

Example response

{
  "job_id": "5c2f59e8-826e-452c-b28d-27ef1f8b32a3"
}

Changes

    • breaking

      removed the success response with the status

    • info

      added the success response with the status

    • info

      added the success response with the status