KosmoKrator

data

RabbitMQ Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the RabbitMQ KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.rabbitmq.*. Use lua_read_doc("integrations.rabbitmq") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic RabbitMQ workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.rabbitmq.get_overview({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("rabbitmq"))' --json
kosmo integrations:lua --eval 'print(docs.read("rabbitmq.get_overview"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local rabbitmq = app.integrations.rabbitmq
local result = rabbitmq.get_overview({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.rabbitmq, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.rabbitmq.default.* or app.integrations.rabbitmq.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need RabbitMQ, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

RabbitMQ - Lua API Reference

Namespace: app.integrations.rabbitmq

This integration wraps the RabbitMQ Management HTTP API. It uses HTTP Basic authentication and the configured Management plugin base URL, usually http://host:15672. Virtual host names are encoded by the integration, so pass / as the default vhost rather than %2F.

The API can mutate broker state. Tools named delete_*, purge_queue, get_messages, publish_message, declare_*, create_*, set_permissions, and import_definitions should only be used when that operational effect is intended.

Cluster And Health

local overview = app.integrations.rabbitmq.get_overview({})
local nodes = app.integrations.rabbitmq.list_nodes({})
local node = app.integrations.rabbitmq.get_node({ name = "rabbit@node1" })

local health = app.integrations.rabbitmq.health_check({
  check = "alarms"
})

local listener = app.integrations.rabbitmq.health_check({
  check = "port-listener",
  params = { port = 5672 }
})

local alive = app.integrations.rabbitmq.aliveness_test({
  vhost = "/"
})

Health check names are RabbitMQ endpoint names such as alarms, local-alarms, virtual-hosts, port-listener, protocol-listener, certificate-expiration, node-is-mirror-sync-critical, and node-is-quorum-critical.

Queues

local all = app.integrations.rabbitmq.list_queues({})
local vhost_queues = app.integrations.rabbitmq.list_queues({
  vhost = "/",
  params = { disable_stats = true, enable_queue_totals = true }
})

local queue = app.integrations.rabbitmq.get_queue({
  vhost = "/",
  name = "orders.ready"
})

app.integrations.rabbitmq.declare_queue({
  vhost = "/",
  name = "orders.ready",
  definition = {
    durable = true,
    auto_delete = false,
    arguments = { ["x-queue-type"] = "quorum" }
  }
})

local bindings = app.integrations.rabbitmq.get_queue_bindings({
  vhost = "/",
  name = "orders.ready"
})

Destructive or state-changing queue tools:

app.integrations.rabbitmq.get_messages({
  vhost = "/",
  name = "orders.ready",
  options = {
    count = 5,
    ackmode = "ack_requeue_true",
    encoding = "auto",
    truncate = 50000
  }
})

app.integrations.rabbitmq.purge_queue({ vhost = "/", name = "orders.ready" })
app.integrations.rabbitmq.delete_queue({ vhost = "/", name = "orders.ready", if_empty = true, if_unused = true })

get_messages defaults to ack_requeue_true so messages are requeued unless the caller explicitly changes ackmode.

Exchanges And Bindings

local exchanges = app.integrations.rabbitmq.list_exchanges({
  vhost = "/"
})

local exchange = app.integrations.rabbitmq.get_exchange({
  vhost = "/",
  name = "orders.events"
})

app.integrations.rabbitmq.declare_exchange({
  vhost = "/",
  name = "orders.events",
  definition = { type = "topic", durable = true, auto_delete = false, arguments = {} }
})

local routed = app.integrations.rabbitmq.publish_message({
  vhost = "/",
  exchange = "orders.events",
  message = {
    properties = {},
    routing_key = "order.created",
    payload = "{\"id\":\"ord_123\"}",
    payload_encoding = "string"
  }
})

Binding tools:

  • list_bindings({ vhost = "/" })
  • list_exchange_source_bindings({ vhost = "/", name = "orders.events" })
  • list_exchange_destination_bindings({ vhost = "/", name = "orders.archive" })
  • create_binding({ vhost = "/", source = "orders.events", destination_type = "queue", destination = "orders.ready", routing_key = "order.*", arguments = {} })
  • delete_binding({ vhost = "/", source = "orders.events", destination_type = "queue", destination = "orders.ready", properties_key = "order.*" })
  • delete_exchange({ vhost = "/", name = "orders.events", if_unused = true })

RabbitMQ uses destination type queue or exchange; the integration maps those to the HTTP API path segments q and e.

Connections, Channels, And Consumers

local connections = app.integrations.rabbitmq.list_connections({})
local connection = app.integrations.rabbitmq.get_connection({
  name = "127.0.0.1:50000 -> 127.0.0.1:5672"
})

local channels = app.integrations.rabbitmq.list_channels({})
local channel = app.integrations.rabbitmq.get_channel({
  name = "127.0.0.1:50000 -> 127.0.0.1:5672 (1)"
})

local consumers = app.integrations.rabbitmq.list_consumers({
  vhost = "/"
})

close_connection({ name = "...", reason = "maintenance" }) force-closes an AMQP connection.

Virtual Hosts, Users, Permissions, And Policies

local vhosts = app.integrations.rabbitmq.list_vhosts({})
local vhost = app.integrations.rabbitmq.get_vhost({ name = "/" })

app.integrations.rabbitmq.create_vhost({
  name = "events",
  metadata = {
    description = "Event bus",
    tags = "production",
    default_queue_type = "quorum"
  }
})

local users = app.integrations.rabbitmq.list_users({})
local user = app.integrations.rabbitmq.get_user({ name = "agent-monitor" })
local permissions = app.integrations.rabbitmq.list_permissions({})
local vhost_permissions = app.integrations.rabbitmq.list_vhost_permissions({ vhost = "/" })
local policies = app.integrations.rabbitmq.list_policies({ vhost = "/" })

Permission mutation tools:

app.integrations.rabbitmq.set_permissions({
  vhost = "/",
  user = "agent-monitor",
  configure = "^$",
  write = "^$",
  read = ".*"
})

app.integrations.rabbitmq.delete_permissions({
  vhost = "/",
  user = "agent-monitor"
})

delete_vhost({ name = "events" }) removes a virtual host when the broker permits deletion.

Definitions

local definitions = app.integrations.rabbitmq.export_definitions({})

app.integrations.rabbitmq.import_definitions({
  definitions = definitions
})

Definitions can include users, vhosts, permissions, policies, queues, exchanges, and bindings. Treat imports as broker configuration changes.

Multi-Account Usage

app.integrations.rabbitmq.list_queues({})
app.integrations.rabbitmq.default.list_queues({})
app.integrations.rabbitmq.production.list_queues({})

Named account namespaces use the same tools with different stored credentials.

Raw agent markdown 
# RabbitMQ - Lua API Reference

Namespace: `app.integrations.rabbitmq`

This integration wraps the RabbitMQ Management HTTP API. It uses HTTP Basic authentication and the configured Management plugin base URL, usually `http://host:15672`. Virtual host names are encoded by the integration, so pass `/` as the default vhost rather than `%2F`.

The API can mutate broker state. Tools named `delete_*`, `purge_queue`, `get_messages`, `publish_message`, `declare_*`, `create_*`, `set_permissions`, and `import_definitions` should only be used when that operational effect is intended.

## Cluster And Health

```lua
local overview = app.integrations.rabbitmq.get_overview({})
local nodes = app.integrations.rabbitmq.list_nodes({})
local node = app.integrations.rabbitmq.get_node({ name = "rabbit@node1" })

local health = app.integrations.rabbitmq.health_check({
  check = "alarms"
})

local listener = app.integrations.rabbitmq.health_check({
  check = "port-listener",
  params = { port = 5672 }
})

local alive = app.integrations.rabbitmq.aliveness_test({
  vhost = "/"
})
```

Health check names are RabbitMQ endpoint names such as `alarms`, `local-alarms`, `virtual-hosts`, `port-listener`, `protocol-listener`, `certificate-expiration`, `node-is-mirror-sync-critical`, and `node-is-quorum-critical`.

## Queues

```lua
local all = app.integrations.rabbitmq.list_queues({})
local vhost_queues = app.integrations.rabbitmq.list_queues({
  vhost = "/",
  params = { disable_stats = true, enable_queue_totals = true }
})

local queue = app.integrations.rabbitmq.get_queue({
  vhost = "/",
  name = "orders.ready"
})

app.integrations.rabbitmq.declare_queue({
  vhost = "/",
  name = "orders.ready",
  definition = {
    durable = true,
    auto_delete = false,
    arguments = { ["x-queue-type"] = "quorum" }
  }
})

local bindings = app.integrations.rabbitmq.get_queue_bindings({
  vhost = "/",
  name = "orders.ready"
})
```

Destructive or state-changing queue tools:

```lua
app.integrations.rabbitmq.get_messages({
  vhost = "/",
  name = "orders.ready",
  options = {
    count = 5,
    ackmode = "ack_requeue_true",
    encoding = "auto",
    truncate = 50000
  }
})

app.integrations.rabbitmq.purge_queue({ vhost = "/", name = "orders.ready" })
app.integrations.rabbitmq.delete_queue({ vhost = "/", name = "orders.ready", if_empty = true, if_unused = true })
```

`get_messages` defaults to `ack_requeue_true` so messages are requeued unless the caller explicitly changes `ackmode`.

## Exchanges And Bindings

```lua
local exchanges = app.integrations.rabbitmq.list_exchanges({
  vhost = "/"
})

local exchange = app.integrations.rabbitmq.get_exchange({
  vhost = "/",
  name = "orders.events"
})

app.integrations.rabbitmq.declare_exchange({
  vhost = "/",
  name = "orders.events",
  definition = { type = "topic", durable = true, auto_delete = false, arguments = {} }
})

local routed = app.integrations.rabbitmq.publish_message({
  vhost = "/",
  exchange = "orders.events",
  message = {
    properties = {},
    routing_key = "order.created",
    payload = "{\"id\":\"ord_123\"}",
    payload_encoding = "string"
  }
})
```

Binding tools:

- `list_bindings({ vhost = "/" })`
- `list_exchange_source_bindings({ vhost = "/", name = "orders.events" })`
- `list_exchange_destination_bindings({ vhost = "/", name = "orders.archive" })`
- `create_binding({ vhost = "/", source = "orders.events", destination_type = "queue", destination = "orders.ready", routing_key = "order.*", arguments = {} })`
- `delete_binding({ vhost = "/", source = "orders.events", destination_type = "queue", destination = "orders.ready", properties_key = "order.*" })`
- `delete_exchange({ vhost = "/", name = "orders.events", if_unused = true })`

RabbitMQ uses destination type `queue` or `exchange`; the integration maps those to the HTTP API path segments `q` and `e`.

## Connections, Channels, And Consumers

```lua
local connections = app.integrations.rabbitmq.list_connections({})
local connection = app.integrations.rabbitmq.get_connection({
  name = "127.0.0.1:50000 -> 127.0.0.1:5672"
})

local channels = app.integrations.rabbitmq.list_channels({})
local channel = app.integrations.rabbitmq.get_channel({
  name = "127.0.0.1:50000 -> 127.0.0.1:5672 (1)"
})

local consumers = app.integrations.rabbitmq.list_consumers({
  vhost = "/"
})
```

`close_connection({ name = "...", reason = "maintenance" })` force-closes an AMQP connection.

## Virtual Hosts, Users, Permissions, And Policies

```lua
local vhosts = app.integrations.rabbitmq.list_vhosts({})
local vhost = app.integrations.rabbitmq.get_vhost({ name = "/" })

app.integrations.rabbitmq.create_vhost({
  name = "events",
  metadata = {
    description = "Event bus",
    tags = "production",
    default_queue_type = "quorum"
  }
})

local users = app.integrations.rabbitmq.list_users({})
local user = app.integrations.rabbitmq.get_user({ name = "agent-monitor" })
local permissions = app.integrations.rabbitmq.list_permissions({})
local vhost_permissions = app.integrations.rabbitmq.list_vhost_permissions({ vhost = "/" })
local policies = app.integrations.rabbitmq.list_policies({ vhost = "/" })
```

Permission mutation tools:

```lua
app.integrations.rabbitmq.set_permissions({
  vhost = "/",
  user = "agent-monitor",
  configure = "^$",
  write = "^$",
  read = ".*"
})

app.integrations.rabbitmq.delete_permissions({
  vhost = "/",
  user = "agent-monitor"
})
```

`delete_vhost({ name = "events" })` removes a virtual host when the broker permits deletion.

## Definitions

```lua
local definitions = app.integrations.rabbitmq.export_definitions({})

app.integrations.rabbitmq.import_definitions({
  definitions = definitions
})
```

Definitions can include users, vhosts, permissions, policies, queues, exchanges, and bindings. Treat imports as broker configuration changes.

## Multi-Account Usage

```lua
app.integrations.rabbitmq.list_queues({})
app.integrations.rabbitmq.default.list_queues({})
app.integrations.rabbitmq.production.list_queues({})
```

Named account namespaces use the same tools with different stored credentials.
Metadata-derived Lua example 
local result = app.integrations.rabbitmq.get_overview({})
print(result)

Functions

get_overview Read

Get RabbitMQ cluster overview — node info, RabbitMQ version, message rates, queue totals, and listener ports.

Lua path
app.integrations.rabbitmq.get_overview
Full name
rabbitmq.rabbitmq_get_overview
ParameterTypeRequiredDescription
No parameters.
list_nodes Read

List RabbitMQ cluster nodes with runtime and resource metrics.

Lua path
app.integrations.rabbitmq.list_nodes
Full name
rabbitmq.rabbitmq_list_nodes
ParameterTypeRequiredDescription
No parameters.
get_node Read

Get details for a RabbitMQ cluster node.

Lua path
app.integrations.rabbitmq.get_node
Full name
rabbitmq.rabbitmq_get_node
ParameterTypeRequiredDescription
name string yes RabbitMQ node name.
health_check Read

Run a RabbitMQ management health check such as alarms, local-alarms, virtual-hosts, port-listener, or protocol-listener.

Lua path
app.integrations.rabbitmq.health_check
Full name
rabbitmq.rabbitmq_health_check
ParameterTypeRequiredDescription
check string yes Health check name.
params object no Optional query parameters such as port, protocol, or timeout.
aliveness_test Read

Run RabbitMQ aliveness test for a virtual host.

Lua path
app.integrations.rabbitmq.aliveness_test
Full name
rabbitmq.rabbitmq_aliveness_test
ParameterTypeRequiredDescription
vhost string no Virtual host name. Defaults to /.
list_queues Read

List all RabbitMQ queues across all virtual hosts. Returns queue names, vhost, message counts, consumer counts, and state.

Lua path
app.integrations.rabbitmq.list_queues
Full name
rabbitmq.rabbitmq_list_queues
ParameterTypeRequiredDescription
vhost string no Optional virtual host name.
params object no Optional query parameters: page, page_size, name, use_regex, disable_stats, enable_queue_totals.
get_queue Read

Get detailed information about a specific RabbitMQ queue, including message counts, consumers, bindings, policy, and arguments.

Lua path
app.integrations.rabbitmq.get_queue
Full name
rabbitmq.rabbitmq_get_queue
ParameterTypeRequiredDescription
vhost string yes The virtual host containing the queue (e.g., "/").
name string yes The queue name.
declare_queue Write

Declare or update a RabbitMQ queue.

Lua path
app.integrations.rabbitmq.declare_queue
Full name
rabbitmq.rabbitmq_declare_queue
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Queue name.
definition object no Queue definition: durable, auto_delete, arguments, node.
delete_queue Write

Delete a RabbitMQ queue, optionally only if empty or unused.

Lua path
app.integrations.rabbitmq.delete_queue
Full name
rabbitmq.rabbitmq_delete_queue
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Queue name.
if_empty boolean no Only delete when the queue is empty.
if_unused boolean no Only delete when the queue is unused.
purge_queue Write

Purge ready messages from a RabbitMQ queue.

Lua path
app.integrations.rabbitmq.purge_queue
Full name
rabbitmq.rabbitmq_purge_queue
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Queue name.
get_queue_bindings Read

List RabbitMQ bindings for a specific queue.

Lua path
app.integrations.rabbitmq.get_queue_bindings
Full name
rabbitmq.rabbitmq_get_queue_bindings
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Queue name.
get_messages Write

Get messages from a RabbitMQ queue using the management API. ackmode controls whether messages are requeued.

Lua path
app.integrations.rabbitmq.get_messages
Full name
rabbitmq.rabbitmq_get_messages
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Queue name.
options object no Options: count, ackmode, encoding, truncate. Defaults to safe requeue mode.
list_exchanges Read

List all RabbitMQ exchanges across all virtual hosts. Returns exchange names, types, vhost, and durability.

Lua path
app.integrations.rabbitmq.list_exchanges
Full name
rabbitmq.rabbitmq_list_exchanges
ParameterTypeRequiredDescription
vhost string no Optional virtual host name.
params object no Optional query parameters.
get_exchange Read

Get details for a RabbitMQ exchange.

Lua path
app.integrations.rabbitmq.get_exchange
Full name
rabbitmq.rabbitmq_get_exchange
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Exchange name.
declare_exchange Write

Declare or update a RabbitMQ exchange.

Lua path
app.integrations.rabbitmq.declare_exchange
Full name
rabbitmq.rabbitmq_declare_exchange
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Exchange name.
definition object yes Exchange definition: type, durable, auto_delete, internal, arguments.
delete_exchange Write

Delete a RabbitMQ exchange, optionally only if unused.

Lua path
app.integrations.rabbitmq.delete_exchange
Full name
rabbitmq.rabbitmq_delete_exchange
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Exchange name.
if_unused boolean no Only delete when the exchange is unused.
publish_message Write

Publish a message to a RabbitMQ exchange through the management API.

Lua path
app.integrations.rabbitmq.publish_message
Full name
rabbitmq.rabbitmq_publish_message
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
exchange string yes Exchange name. Use empty string for default exchange.
message object yes Message payload: properties, routing_key, payload, payload_encoding.
list_source_bindings Read

List bindings where a RabbitMQ exchange is the source.

Lua path
app.integrations.rabbitmq.list_source_bindings
Full name
rabbitmq.rabbitmq_list_exchange_source_bindings
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Exchange name.
list_destination_bindings Read

List bindings where a RabbitMQ exchange is the destination.

Lua path
app.integrations.rabbitmq.list_destination_bindings
Full name
rabbitmq.rabbitmq_list_exchange_destination_bindings
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
name string yes Exchange name.
list_bindings Read

List RabbitMQ bindings globally or for a virtual host.

Lua path
app.integrations.rabbitmq.list_bindings
Full name
rabbitmq.rabbitmq_list_bindings
ParameterTypeRequiredDescription
vhost string no Optional virtual host name.
create_binding Write

Create a RabbitMQ binding from an exchange to a queue or exchange.

Lua path
app.integrations.rabbitmq.create_binding
Full name
rabbitmq.rabbitmq_create_binding
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
source string yes Source exchange name.
destination_type string yes Destination type: queue or exchange.
destination string yes Destination queue or exchange name.
routing_key string no Binding routing key.
arguments object no Binding arguments.
delete_binding Write

Delete a RabbitMQ binding by properties key.

Lua path
app.integrations.rabbitmq.delete_binding
Full name
rabbitmq.rabbitmq_delete_binding
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
source string yes Source exchange name.
destination_type string yes Destination type: queue or exchange.
destination string yes Destination queue or exchange name.
properties_key string yes Binding properties_key returned by RabbitMQ.
list_connections Read

List all active RabbitMQ AMQP connections. Returns client info, peer host/port, channels, and connection state.

Lua path
app.integrations.rabbitmq.list_connections
Full name
rabbitmq.rabbitmq_list_connections
ParameterTypeRequiredDescription
No parameters.
get_connection Read

Get details for one RabbitMQ connection.

Lua path
app.integrations.rabbitmq.get_connection
Full name
rabbitmq.rabbitmq_get_connection
ParameterTypeRequiredDescription
name string yes Connection name from RabbitMQ.
close_connection Write

Close a RabbitMQ connection by name.

Lua path
app.integrations.rabbitmq.close_connection
Full name
rabbitmq.rabbitmq_close_connection
ParameterTypeRequiredDescription
name string yes Connection name from RabbitMQ.
reason string no Optional close reason.
list_channels Read

List RabbitMQ channels.

Lua path
app.integrations.rabbitmq.list_channels
Full name
rabbitmq.rabbitmq_list_channels
ParameterTypeRequiredDescription
No parameters.
get_channel Read

Get details for one RabbitMQ channel.

Lua path
app.integrations.rabbitmq.get_channel
Full name
rabbitmq.rabbitmq_get_channel
ParameterTypeRequiredDescription
name string yes Channel name from RabbitMQ.
list_consumers Read

List RabbitMQ consumers globally or for a virtual host.

Lua path
app.integrations.rabbitmq.list_consumers
Full name
rabbitmq.rabbitmq_list_consumers
ParameterTypeRequiredDescription
vhost string no Optional virtual host name.
list_vhosts Read

List all RabbitMQ virtual hosts. Returns vhost names, tracing status, and message counts.

Lua path
app.integrations.rabbitmq.list_vhosts
Full name
rabbitmq.rabbitmq_list_vhosts
ParameterTypeRequiredDescription
No parameters.
get_vhost Read

Get details for one RabbitMQ virtual host.

Lua path
app.integrations.rabbitmq.get_vhost
Full name
rabbitmq.rabbitmq_get_vhost
ParameterTypeRequiredDescription
name string yes Virtual host name.
create_vhost Write

Create or update a RabbitMQ virtual host.

Lua path
app.integrations.rabbitmq.create_vhost
Full name
rabbitmq.rabbitmq_create_vhost
ParameterTypeRequiredDescription
name string yes Virtual host name.
metadata object no Optional metadata: description, tags, default_queue_type, protected_from_deletion, tracing.
delete_vhost Write

Delete a RabbitMQ virtual host.

Lua path
app.integrations.rabbitmq.delete_vhost
Full name
rabbitmq.rabbitmq_delete_vhost
ParameterTypeRequiredDescription
name string yes Virtual host name.
list_vhost_permissions Read

List RabbitMQ permissions for a virtual host.

Lua path
app.integrations.rabbitmq.list_vhost_permissions
Full name
rabbitmq.rabbitmq_list_vhost_permissions
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
list_users Read

List RabbitMQ users.

Lua path
app.integrations.rabbitmq.list_users
Full name
rabbitmq.rabbitmq_list_users
ParameterTypeRequiredDescription
No parameters.
get_user Read

Get details for one RabbitMQ user.

Lua path
app.integrations.rabbitmq.get_user
Full name
rabbitmq.rabbitmq_get_user
ParameterTypeRequiredDescription
name string yes RabbitMQ username.
list_permissions Read

List RabbitMQ permissions across all virtual hosts.

Lua path
app.integrations.rabbitmq.list_permissions
Full name
rabbitmq.rabbitmq_list_permissions
ParameterTypeRequiredDescription
No parameters.
set_permissions Write

Set RabbitMQ configure, write, and read permissions for a user on a virtual host.

Lua path
app.integrations.rabbitmq.set_permissions
Full name
rabbitmq.rabbitmq_set_permissions
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
user string yes RabbitMQ username.
configure string yes Configure regex.
write string yes Write regex.
read string yes Read regex.
delete_permissions Write

Delete RabbitMQ permissions for a user on a virtual host.

Lua path
app.integrations.rabbitmq.delete_permissions
Full name
rabbitmq.rabbitmq_delete_permissions
ParameterTypeRequiredDescription
vhost string yes Virtual host name.
user string yes RabbitMQ username.
list_policies Read

List RabbitMQ policies globally or for a virtual host.

Lua path
app.integrations.rabbitmq.list_policies
Full name
rabbitmq.rabbitmq_list_policies
ParameterTypeRequiredDescription
vhost string no Optional virtual host name.
export_definitions Read

Export RabbitMQ broker definitions.

Lua path
app.integrations.rabbitmq.export_definitions
Full name
rabbitmq.rabbitmq_export_definitions
ParameterTypeRequiredDescription
No parameters.
import_definitions Write

Import RabbitMQ broker definitions.

Lua path
app.integrations.rabbitmq.import_definitions
Full name
rabbitmq.rabbitmq_import_definitions
ParameterTypeRequiredDescription
definitions object yes RabbitMQ definitions document.