Management

Client for the RabbitMQ Management HTTP API.

This class provides a structured interface to manage a RabbitMQ cluster, including vhosts, users, exchanges, queues, and health monitoring. It supports both manual session management and asynchronous context managers.

Example

async with AsyncRMQManagementAPI(
    "http://localhost:15672", "guest", "guest"
) as client:
    overview = await client.overview()

client = AsyncRMQManagementAPI("http://localhost:15672", "guest", "guest")
overview = await client.overview()
await client.close()

Attributes:

Name	Type	Description
auth		Authentication and security checks.
bindings		Exchange and queue bindings management.
channels		Active AMQP channels monitoring.
connections		Client TCP connections management.
consumers		Message consumers monitoring.
definitions		Import/Export of server definitions.
exchanges		Exchange management.
health		Cluster and node health checks.
nodes		Cluster nodes monitoring.
parameters		Runtime parameters and federation.
permissions		User permissions management.
policies		Runtime policies management.
queues		Queue management and messaging.
users		User account management.
vhosts		Virtual host management.

aliveness_test(vhost: str) -> dict async

Execute a basic health check by publishing and consuming a test message.

change_cluster_name(name: str) -> dict async

Update the cluster name.

close() -> None async

Close the underlying HTTP session and release resources.

cluster_name() -> dict async

Get the name identifying this RabbitMQ cluster.

extensions() -> list[dict] async

List all active management plugin extensions.

overview() -> dict async

Get system-wide information (cluster state, versions, stats).

rebalance_queues() -> dict async

Trigger asynchronous queue rebalancing across all virtual hosts.

whoami() -> dict async

Get details of the currently authenticated user.