Download OpenAPI specification:Download
HTTP API to programmatically manage all aspects of LavinMQ.
List all bindings for a specific vhost.
vhost required | string Name of vhost. |
[- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
]
List all bindings between a specific exchange and queue.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
queue required | string Name of queue. |
[- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
]
Create a binding between an exchange and a queue.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
queue required | string Name of queue. |
routing_key required | string |
arguments | object |
{- "routing_key": "string",
- "arguments": { }
}
{- "error": "string",
- "reason": "string"
}
List a specific binding between an exchange and queue.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
queue required | string Name of queue. |
props required | string The |
{- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
Delete a specific binding between an exchange and queue.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
queue required | string Name of queue. |
props required | string The |
{- "error": "string",
- "reason": "string"
}
List all bindings between two exchanges.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
destination required | string Name of exchange (destination). |
[- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
]
Create a binding between two exchanges.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
destination required | string Name of exchange (destination). |
{- "error": "string",
- "reason": "string"
}
List a specific binding between two exchanges.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
destination required | string Name of exchange (destination). |
props required | string The |
{- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
Delete a specific binding between two exchanges.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
destination required | string Name of exchange (destination). |
props required | string The |
{- "error": "string",
- "reason": "string"
}
[- {
- "number": 0,
- "name": "string",
- "vhost": "string",
- "user": "string",
- "consumer_count": 0,
- "prefetch_count": 0,
- "global_prefetch_count": 0,
- "confirm": true,
- "transactional": true,
- "messages_unacknowledged": 0,
- "connection_details": {
- "peer_host": "string",
- "peer_port": 0,
- "name": "string"
}, - "state": "string",
- "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "confirm": 0,
- "confirm_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}
}
]
Details for all open channels for a specific vhost.
vhost required | string Name of vhost. |
[- {
- "number": 0,
- "name": "string",
- "vhost": "string",
- "user": "string",
- "consumer_count": 0,
- "prefetch_count": 0,
- "global_prefetch_count": 0,
- "confirm": true,
- "transactional": true,
- "messages_unacknowledged": 0,
- "connection_details": {
- "peer_host": "string",
- "peer_port": 0,
- "name": "string"
}, - "state": "string",
- "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "confirm": 0,
- "confirm_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}
}
]
Details for a specific channel.
name required | string Name of channel. |
{- "number": 0,
- "name": "string",
- "vhost": "string",
- "user": "string",
- "consumer_count": 0,
- "prefetch_count": 0,
- "global_prefetch_count": 0,
- "confirm": true,
- "transactional": true,
- "messages_unacknowledged": 0,
- "connection_details": {
- "peer_host": "string",
- "peer_port": 0,
- "name": "string"
}, - "state": "string",
- "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "confirm": 0,
- "confirm_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "consumer_details": [
- {
- "queue": {
- "name": "string",
- "vhost": "string"
}, - "consumer_tag": "string",
- "exclusive": true,
- "ack_required": true,
- "prefetch_count": 0,
- "channel_details": {
- "peer_host": "string",
- "peer_port": 0,
- "connection_name": "string",
- "user": "string",
- "number": 0,
- "name": "string"
}
}
]
}
[- {
- "channels": 0,
- "connected_at": 0,
- "type": "string",
- "channel_max": 0,
- "timeout": 0,
- "client_properties": {
- "capabilities": {
- "publisher_confirms": true,
- "consumer_cancel_notify": true,
- "exchange_exchange_bindings": true,
- "basic.nack": true,
- "connection.blocked": true,
- "authentication_failure_close": true
}, - "product": "string",
- "platform": "string",
- "version": "string",
- "information": "string",
- "connection_name": "string"
}, - "vhost": "string",
- "user": "string",
- "protocol": "string",
- "auth_mechanism": "AMQPLAIN",
- "host": "string",
- "port": 0,
- "peer_host": "string",
- "peer_port": 0,
- "name": "string",
- "ssl": true,
- "tls_version": "string",
- "cipher": "string",
- "state": "string",
- "send_oct": 0,
- "send_oct_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "recv_oct": 0,
- "recv_oct_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "channel_created": 0,
- "channel_created_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "channel_closed": 0,
- "channel_closed_details": {
- "rate": 0,
- "log": [
- 0
]
}
}
]
Details for all open connections for a specific vhost.
vhost required | string Name of vhost. |
[- {
- "channels": 0,
- "connected_at": 0,
- "type": "string",
- "channel_max": 0,
- "timeout": 0,
- "client_properties": {
- "capabilities": {
- "publisher_confirms": true,
- "consumer_cancel_notify": true,
- "exchange_exchange_bindings": true,
- "basic.nack": true,
- "connection.blocked": true,
- "authentication_failure_close": true
}, - "product": "string",
- "platform": "string",
- "version": "string",
- "information": "string",
- "connection_name": "string"
}, - "vhost": "string",
- "user": "string",
- "protocol": "string",
- "auth_mechanism": "AMQPLAIN",
- "host": "string",
- "port": 0,
- "peer_host": "string",
- "peer_port": 0,
- "name": "string",
- "ssl": true,
- "tls_version": "string",
- "cipher": "string",
- "state": "string",
- "send_oct": 0,
- "send_oct_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "recv_oct": 0,
- "recv_oct_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "channel_created": 0,
- "channel_created_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "channel_closed": 0,
- "channel_closed_details": {
- "rate": 0,
- "log": [
- 0
]
}
}
]
Details for specific connection.
name required | string Name of connection. |
{- "channels": 0,
- "connected_at": 0,
- "type": "string",
- "channel_max": 0,
- "timeout": 0,
- "client_properties": {
- "capabilities": {
- "publisher_confirms": true,
- "consumer_cancel_notify": true,
- "exchange_exchange_bindings": true,
- "basic.nack": true,
- "connection.blocked": true,
- "authentication_failure_close": true
}, - "product": "string",
- "platform": "string",
- "version": "string",
- "information": "string",
- "connection_name": "string"
}, - "vhost": "string",
- "user": "string",
- "protocol": "string",
- "auth_mechanism": "AMQPLAIN",
- "host": "string",
- "port": 0,
- "peer_host": "string",
- "peer_port": 0,
- "name": "string",
- "ssl": true,
- "tls_version": "string",
- "cipher": "string",
- "state": "string",
- "send_oct": 0,
- "send_oct_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "recv_oct": 0,
- "recv_oct_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "channel_created": 0,
- "channel_created_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "channel_closed": 0,
- "channel_closed_details": {
- "rate": 0,
- "log": [
- 0
]
}
}
Details for open channels for specific connection.
name required | string Name of connection. |
[- {
- "number": 0,
- "name": "string",
- "vhost": "string",
- "user": "string",
- "consumer_count": 0,
- "prefetch_count": 0,
- "global_prefetch_count": 0,
- "confirm": true,
- "transactional": true,
- "messages_unacknowledged": 0,
- "connection_details": {
- "peer_host": "string",
- "peer_port": 0,
- "name": "string"
}, - "state": "string",
- "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "confirm": 0,
- "confirm_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}
}
]
[- {
- "queue": {
- "name": "string",
- "vhost": "string"
}, - "consumer_tag": "string",
- "exclusive": true,
- "ack_required": true,
- "prefetch_count": 0,
- "channel_details": {
- "peer_host": "string",
- "peer_port": 0,
- "connection_name": "string",
- "user": "string",
- "number": 0,
- "name": "string"
}
}
]
List all consumers for a specific vhost.
vhost required | string Name of vhost. |
[- {
- "queue": {
- "name": "string",
- "vhost": "string"
}, - "consumer_tag": "string",
- "exclusive": true,
- "ack_required": true,
- "prefetch_count": 0,
- "channel_details": {
- "peer_host": "string",
- "peer_port": 0,
- "connection_name": "string",
- "user": "string",
- "number": 0,
- "name": "string"
}
}
]
Cancel a specific consumer (unsubscribe).
vhost required | string Name of vhost. |
connection required | string Name of connection. |
channel required | integer The channel (number) ID. |
consumer_tag required | string The consumer tag. |
{- "error": "string",
- "reason": "string"
}
{- "lavinmq_version": "string",
- "users": [
- {
- "tags": "administrator",
- "hashing_algorithm": "SHA512",
- "password_hash": "string",
- "name": "string"
}
], - "vhosts": [
- {
- "name": "string",
- "dir": "string",
- "tracing": true,
- "cluster_state": { }
}
], - "queues": [
- {
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "arguments": { }
}
], - "exchanges": [
- {
- "type": "direct",
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "internal": true,
- "arguments": { }
}
], - "bindings": [
- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
], - "permissions": [
- {
- "user": "string",
- "vhost": "string",
- "configure": "string",
- "read": "string",
- "write": "string"
}
], - "policies": [
- {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}
], - "parameters": [
- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
], - "global_parameters": [
- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
]
}
Import server definitions. Merged with existing definitions on the server.
Array of objects (users) | |
Array of objects (definitions_vhosts) | |
Array of objects (definitions_queues) | |
Array of objects (definitions_exchanges) | |
Array of objects (bindings) | |
Array of objects (permissions) | |
Array of objects (policies) | |
Array of objects (parameters) | |
Array of objects (global-parameters) |
{- "users": [
- {
- "tags": "administrator",
- "hashing_algorithm": "SHA512",
- "password_hash": "string",
- "name": "string"
}
], - "vhosts": [
- {
- "name": "string",
- "dir": "string",
- "tracing": true,
- "cluster_state": { }
}
], - "queues": [
- {
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "arguments": { }
}
], - "exchanges": [
- {
- "type": "direct",
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "internal": true,
- "arguments": { }
}
], - "bindings": [
- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
], - "permissions": [
- {
- "user": "string",
- "vhost": "string",
- "configure": "string",
- "read": "string",
- "write": "string"
}
], - "policies": [
- {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}
], - "parameters": [
- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
], - "global_parameters": [
- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
]
}
{- "lavinmq_version": "string",
- "users": [
- {
- "tags": "administrator",
- "hashing_algorithm": "SHA512",
- "password_hash": "string",
- "name": "string"
}
], - "vhosts": [
- {
- "name": "string",
- "dir": "string",
- "tracing": true,
- "cluster_state": { }
}
], - "queues": [
- {
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "arguments": { }
}
], - "exchanges": [
- {
- "type": "direct",
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "internal": true,
- "arguments": { }
}
], - "bindings": [
- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
], - "permissions": [
- {
- "user": "string",
- "vhost": "string",
- "configure": "string",
- "read": "string",
- "write": "string"
}
], - "policies": [
- {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}
], - "parameters": [
- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
], - "global_parameters": [
- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
]
}
Upload file with server definitions. Merged with existing definitions on the server.
file | string <binary> JSON file with definitions, uses the same format as the request body of the |
{- "error": "string",
- "reason": "string"
}
Get definitions for a specifc vhost.
vhost required | string Name of vhost. |
{- "lavinmq_version": "string",
- "queues": [
- {
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "arguments": { }
}
], - "exchanges": [
- {
- "type": "direct",
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "internal": true,
- "arguments": { }
}
], - "bindings": [
- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
], - "policies": [
- {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}
]
}
Import definitions for a specifc vhost. Merged with existing definitions on the server.
vhost required | string Name of vhost. |
Array of objects (definitions_queues) | |
Array of objects (definitions_exchanges) | |
Array of objects (bindings) | |
Array of objects (policies) | |
Array of objects (parameters) |
{- "lavinmq_version": "string",
- "users": [
- {
- "tags": "administrator",
- "hashing_algorithm": "SHA512",
- "password_hash": "string",
- "name": "string"
}
], - "vhosts": [
- {
- "name": "string",
- "dir": "string",
- "tracing": true,
- "cluster_state": { }
}
], - "queues": [
- {
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "arguments": { }
}
], - "exchanges": [
- {
- "type": "direct",
- "name": "string",
- "vhost": "string",
- "durable": true,
- "auto_delete": true,
- "internal": true,
- "arguments": { }
}
], - "bindings": [
- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
], - "permissions": [
- {
- "user": "string",
- "vhost": "string",
- "configure": "string",
- "read": "string",
- "write": "string"
}
], - "policies": [
- {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}
], - "parameters": [
- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
], - "global_parameters": [
- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
]
}
Upload file with vhost definitions. Merged with existing definitions on the server.
vhost required | string Name of vhost. |
file | string <binary> JSON file with vhost definitions, uses the same format as the request body of the |
{- "error": "string",
- "reason": "string"
}
[- {
- "type": "direct",
- "arguments": { },
- "auto_delete": true,
- "durable": true,
- "effective_policy_definition": { },
- "internal": true,
- "message_stats": {
- "publish_in": 0,
- "publish_in_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish_out": 0,
- "publish_out_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "unroutable": 0,
- "unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "name": "string",
- "policy": { },
- "vhost": "string"
}
]
List all exchanges for a specific vhost.
vhost required | string Name of vhost |
[- {
- "type": "direct",
- "arguments": { },
- "auto_delete": true,
- "durable": true,
- "effective_policy_definition": { },
- "internal": true,
- "message_stats": {
- "publish_in": 0,
- "publish_in_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish_out": 0,
- "publish_out_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "unroutable": 0,
- "unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "name": "string",
- "policy": { },
- "vhost": "string"
}
]
Find a specific exchange by vhost and name.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
{- "type": "direct",
- "arguments": { },
- "auto_delete": true,
- "durable": true,
- "effective_policy_definition": { },
- "internal": true,
- "message_stats": {
- "publish_in": 0,
- "publish_in_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish_out": 0,
- "publish_out_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "unroutable": 0,
- "unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "name": "string",
- "policy": { },
- "vhost": "string"
}
Create a new exchange, or update an existing exchange.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
type required | string Enum: "direct" "fanout" "topic" "headers" "x-delayed-message" "x-federation-upstream" "x-consistent-hash" |
durable | boolean Default: false |
auto_delete | boolean Default: false |
internal | boolean Default: false |
delayed | boolean |
arguments | object |
{- "type": "direct",
- "durable": false,
- "auto_delete": false,
- "internal": false,
- "delayed": true,
- "arguments": { }
}
{- "error": "string",
- "reason": "string"
}
List all bindings where the specific exchange is the source.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
[- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
]
List all bindings where the specific exchange is the destination.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
[- {
- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
]
Publish a message to the specific exchange. Check the response body to understand if the message was successfully routed or not.
vhost required | string Name of vhost. |
name required | string Name of exchange. |
required | object |
routing_key required | string |
payload required | string |
payload_encoding required | string Enum: "string" "base64" |
{- "properties": {
- "content_type": "string",
- "content_encoding": "string",
- "headers": { },
- "delivery_mode": 0,
- "priority": 0,
- "correlation_id": "string",
- "reply_to": "string",
- "expiration": "string",
- "message_id": "string",
- "timestamp": 0,
- "type": "string",
- "user_id": "string",
- "app_id": "string",
- "reserved": "string"
}, - "routing_key": "string",
- "payload": "string",
- "payload_encoding": "string"
}
{- "routed": true
}
{- "lavinmq_version": "string",
- "exchange_types": [
- {
- "name": "string"
}
], - "listeners": [
- {
- "ip_address": "string",
- "protocol": "amqp",
- "port": 0
}
], - "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "node": "string",
- "object_totals": {
- "channels": 0,
- "connections": 0,
- "consumers": 0,
- "exchanges": 0,
- "queues": 0
}, - "queue_totals": {
- "messages": 0,
- "messages_ready": 0,
- "messages_unacknowledged": 0,
- "messages_log": [
- 0
], - "messages_ready_log": [
- 0
], - "messages_unacknowledged_log": [
- 0
]
}, - "recv_oct_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "send_oct_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "uptime": 0
}
[- {
- "applications": {
- "name": "string",
- "description": "string",
- "version": "string"
}, - "channel_closed": 0,
- "channel_closed_details": {
- "rate": 0
}, - "channel_created": 0,
- "channel_created_details": {
- "rate": 0
}, - "connection_closed": 0,
- "connection_closed_details": {
- "rate": 0
}, - "connection_created": 0,
- "connection_created_details": {
- "rate": 0
}, - "cpu_sys_details": {
- "log": [
- 0
]
}, - "cpu_sys_time": 0,
- "cpu_user_details": {
- "log": [
- 0
]
}, - "cpu_user_time": 0,
- "db_dir": "string",
- "disk_free": 0,
- "disk_free_details": {
- "log": [
- 0
]
}, - "disk_total": 0,
- "disk_total_details": {
- "log": [
- 0
]
}, - "fd_total": 0,
- "fd_used": 0,
- "io_read_count": 0,
- "io_read_details": {
- "log": [
- 0
]
}, - "io_write_count": 0,
- "io_write_details": {
- "log": [
- 0
]
}, - "mem_limit": 0,
- "mem_used": 0,
- "mem_used_details": {
- "log": [
- 0
]
}, - "name": "string",
- "os_pid": "string",
- "partitions": [ ],
- "proc_used": 0,
- "processors": "string",
- "queue_declared": 0,
- "queue_declared_details": {
- "rate": 0
}, - "queue_deleted": 0,
- "queue_deleted_details": {
- "rate": 0
}, - "run_queue": 0,
- "running": true,
- "sockets_used": 0,
- "uptime": 0
}
]
Get statistics for specific node.
name required | string Name of node. |
{- "applications": {
- "name": "string",
- "description": "string",
- "version": "string"
}, - "channel_closed": 0,
- "channel_closed_details": {
- "rate": 0
}, - "channel_created": 0,
- "channel_created_details": {
- "rate": 0
}, - "connection_closed": 0,
- "connection_closed_details": {
- "rate": 0
}, - "connection_created": 0,
- "connection_created_details": {
- "rate": 0
}, - "cpu_sys_details": {
- "log": [
- 0
]
}, - "cpu_sys_time": 0,
- "cpu_user_details": {
- "log": [
- 0
]
}, - "cpu_user_time": 0,
- "db_dir": "string",
- "disk_free": 0,
- "disk_free_details": {
- "log": [
- 0
]
}, - "disk_total": 0,
- "disk_total_details": {
- "log": [
- 0
]
}, - "fd_total": 0,
- "fd_used": 0,
- "io_read_count": 0,
- "io_read_details": {
- "log": [
- 0
]
}, - "io_write_count": 0,
- "io_write_details": {
- "log": [
- 0
]
}, - "mem_limit": 0,
- "mem_used": 0,
- "mem_used_details": {
- "log": [
- 0
]
}, - "name": "string",
- "os_pid": "string",
- "partitions": [ ],
- "proc_used": 0,
- "processors": "string",
- "queue_declared": 0,
- "queue_declared_details": {
- "rate": 0
}, - "queue_deleted": 0,
- "queue_deleted_details": {
- "rate": 0
}, - "run_queue": 0,
- "running": true,
- "sockets_used": 0,
- "uptime": 0
}
List all parameters for a specific component and vhost.
component required | string Name of component. |
vhost required | string Name of vhost. |
[- {
- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
]
List a specific parameter.
component required | string Name of component. |
vhost required | string Name of vhost. |
name required | string Name of parameter. |
{- "name": "string",
- "value": "string",
- "component": "shovel",
- "vhost": "string"
}
Create or update a parameter.
component required | string Name of component. |
vhost required | string Name of vhost. |
name required | string Name of parameter. |
value required | string |
{- "value": "string"
}
{- "error": "string",
- "reason": "string"
}
Create or update a global parameter.
name required | string Name of global parameter. |
value required | string |
{- "value": "string"
}
{- "error": "string",
- "reason": "string"
}
Create or update a policy.
vhost required | string Name of vhost. |
name required | string Name of policy. |
pattern required | string Regular expression matching queue/exchange name(s) |
definition required | object Optional queue/exchange arguments |
priority | integer Default: 0 |
apply-to | string Default: "all" Enum: "all" "queues" "exchanges" |
{- "pattern": "string",
- "definition": { },
- "priority": 0,
- "apply-to": "all"
}
{- "error": "string",
- "reason": "string"
}
List permissions by vhost and user.
vhost required | string Name of the vhost. |
user required | string Name of the user. |
{- "user": "string",
- "vhost": "string",
- "configure": "string",
- "read": "string",
- "write": "string"
}
Create or update permissions by vhost and user.
vhost required | string Name of the vhost. |
user required | string Name of the user. |
configure required | string Configure permissions (regular expression). |
read required | string Read permissions (regular expression). |
write required | string Write permissions (regular expression). |
{- "configure": "string",
- "read": "string",
- "write": "string"
}
{- "error": "string",
- "reason": "string"
}
[- {
- "name": "string",
- "durable": true,
- "exclusive": true,
- "auto_delete": true,
- "arguments": { },
- "consumers": 0,
- "vhost": "string",
- "messages": 0,
- "ready": 0,
- "ready_bytes": 0,
- "ready_avg_bytes": 0,
- "unacked": 0,
- "unacked_bytes": 0,
- "unacked_avg_bytes": 0,
- "policy": "string",
- "exclusive_consumer_tag": "string",
- "state": "running",
- "effective_policy_definition": {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}, - "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get_no_ack": 0,
- "get_no_ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "internal": true,
- "first_message_timestamp": 0,
- "last_message_timestamp": 0
}
]
List all queues for specific vhost.
vhost required | string Name of vhost. |
[- {
- "name": "string",
- "durable": true,
- "exclusive": true,
- "auto_delete": true,
- "arguments": { },
- "consumers": 0,
- "vhost": "string",
- "messages": 0,
- "ready": 0,
- "ready_bytes": 0,
- "ready_avg_bytes": 0,
- "unacked": 0,
- "unacked_bytes": 0,
- "unacked_avg_bytes": 0,
- "policy": "string",
- "exclusive_consumer_tag": "string",
- "state": "running",
- "effective_policy_definition": {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}, - "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get_no_ack": 0,
- "get_no_ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "internal": true,
- "first_message_timestamp": 0,
- "last_message_timestamp": 0
}
]
Find specific queue by name and vhost.
vhost required | string Name of vhost. |
name required | string Name of queue. |
{- "name": "string",
- "durable": true,
- "exclusive": true,
- "auto_delete": true,
- "arguments": { },
- "consumers": 0,
- "vhost": "string",
- "messages": 0,
- "ready": 0,
- "ready_bytes": 0,
- "ready_avg_bytes": 0,
- "unacked": 0,
- "unacked_bytes": 0,
- "unacked_avg_bytes": 0,
- "policy": "string",
- "exclusive_consumer_tag": "string",
- "state": "running",
- "effective_policy_definition": {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}, - "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get_no_ack": 0,
- "get_no_ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "internal": true,
- "first_message_timestamp": 0,
- "last_message_timestamp": 0,
- "consumer_details": [ ]
}
Create new queue under given vhost, or update an existing queue.
vhost required | string Name of vhost. |
name required | string Name of queue. |
durable | boolean Default: false |
auto_delete | boolean Default: false |
arguments | object |
{- "durable": false,
- "auto_delete": false,
- "arguments": { }
}
{- "error": "string",
- "reason": "string"
}
Pause the queue. When the queue is paused, messages are not delivered to consumers.
vhost required | string Name of vhost. |
name required | string Name of queue. |
[- {
- "name": "string",
- "durable": true,
- "exclusive": true,
- "auto_delete": true,
- "arguments": { },
- "consumers": 0,
- "vhost": "string",
- "messages": 0,
- "ready": 0,
- "ready_bytes": 0,
- "ready_avg_bytes": 0,
- "unacked": 0,
- "unacked_bytes": 0,
- "unacked_avg_bytes": 0,
- "policy": "string",
- "exclusive_consumer_tag": "string",
- "state": "running",
- "effective_policy_definition": {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}, - "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get_no_ack": 0,
- "get_no_ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "internal": true,
- "first_message_timestamp": 0,
- "last_message_timestamp": 0
}
]
Resume the queue. When the queue is paused, messages are not delivered to consumers.
vhost required | string Name of vhost. |
name required | string Name of queue. |
[- {
- "name": "string",
- "durable": true,
- "exclusive": true,
- "auto_delete": true,
- "arguments": { },
- "consumers": 0,
- "vhost": "string",
- "messages": 0,
- "ready": 0,
- "ready_bytes": 0,
- "ready_avg_bytes": 0,
- "unacked": 0,
- "unacked_bytes": 0,
- "unacked_avg_bytes": 0,
- "policy": "string",
- "exclusive_consumer_tag": "string",
- "state": "running",
- "effective_policy_definition": {
- "name": "string",
- "vhost": "string",
- "pattern": "string",
- "apply-to": "all",
- "priority": 0,
- "definition": { }
}, - "message_stats": {
- "ack": 0,
- "ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "deliver": 0,
- "deliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get": 0,
- "get_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "get_no_ack": 0,
- "get_no_ack_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "publish": 0,
- "publish_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "redeliver": 0,
- "redeliver_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "reject": 0,
- "reject_details": {
- "rate": 0,
- "log": [
- 0
]
}, - "return_unroutable": 0,
- "return_unroutable_details": {
- "rate": 0,
- "log": [
- 0
]
}
}, - "internal": true,
- "first_message_timestamp": 0,
- "last_message_timestamp": 0
}
]
List bindings for a specific queue.
vhost required | string Name of vhost. |
name required | string Name of queue. |
{- "source": "string",
- "vhost": "string",
- "destination": "string",
- "destination_type": "exchange",
- "routing_key": "string",
- "arguments": { },
- "properties_key": "string"
}
Get one ore more messages from a specific queue.
vhost required | string Name of vhost. |
name required | string Name of queue. |
count | integer Default: 1 |
ack_mode | string Default: "get" |
encoding | string Default: "auto" Enum: "auto" "base64" |
truncate | string |
requeue | boolean |
{- "count": 1,
- "ack_mode": "get",
- "encoding": "auto",
- "truncate": "string",
- "requeue": true
}
[- {
- "payload_bytes": 0,
- "redelivered": true,
- "exchange": "string",
- "routing_key": "string",
- "message_count": 0,
- "properties": {
- "content_type": "string",
- "content_encoding": "string",
- "headers": { },
- "delivery_mode": 0,
- "priority": 0,
- "correlation_id": "string",
- "reply_to": "string",
- "expiration": "string",
- "message_id": "string",
- "timestamp": "string",
- "type": "string",
- "user_id": "string",
- "app_id": "string",
- "reserved": "string"
}, - "payload": "string",
- "payload_encoding": "string"
}
]
List size details for a specific queue.
vhost required | string Name of vhost. |
name required | string Name of queue. |
{- "messages": 0,
- "ready": 0,
- "ready_bytes": 0,
- "ready_avg_bytes": 0,
- "ready_max_bytes": 0,
- "ready_min_bytes": 0,
- "unacked": 0,
- "unacked_bytes": 0,
- "unacked_avg_bytes": 0,
- "unacked_max_bytes": 0,
- "unacked_min_bytes": 0,
- "first_message_timestamp": 0,
- "last_message_timestamp": 0
}
Delete multiple users.
users required | Array of strings List of users to delete. |
{- "users": [
- "string"
]
}
{- "error": "string",
- "reason": "string"
}
Create new user, or update an existing user.
name required | string Name of the user. |
tags | string Enum: "administrator" "monitoring" "management" "policymaker" "impersonator" List of tags (comma-separated). |
hashing_algorithm | string Enum: "SHA512" "SHA256" "Bcrypt" "MD5" Hashing algorithm used to generate the password hash (defaults to "SHA256" for PUT requests). |
password_hash | string The password hash. |
password | string The password. Either this field or |
{- "tags": "administrator",
- "hashing_algorithm": "SHA512",
- "password_hash": "string",
- "password": "string"
}
{- "error": "string",
- "reason": "string"
}
[- {
- "name": "string",
- "dir": "string",
- "cluster_state": { },
- "messages": 0,
- "messages_unacknowledged": 0,
- "messages_ready": 0,
- "messages_stats": {
- "ack": 0,
- "confirm": 0,
- "deliver": 0,
- "get": 0,
- "get_no_ack": 0,
- "publish": 0,
- "redeliver": 0,
- "return_unroutable": 0
}
}
]
Find a specific vhost by name.
name required | string Name of the vhost |
{- "name": "string",
- "dir": "string",
- "cluster_state": { },
- "messages": 0,
- "messages_unacknowledged": 0,
- "messages_ready": 0,
- "messages_stats": {
- "ack": 0,
- "confirm": 0,
- "deliver": 0,
- "get": 0,
- "get_no_ack": 0,
- "publish": 0,
- "redeliver": 0,
- "return_unroutable": 0
}
}