API docs by Redocly

LavinMQ Management HTTP API (1.1.3)

Download OpenAPI specification:Download

LavinMQ Team: contact@lavinmq.com URL: https://www.lavinmq.com/

HTTP API to programmatically manage all aspects of LavinMQ.

bindings

Manage bindings.

List all bindings

List all bindings.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List bindings by vhost

List all bindings for a specific vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List queue bindings

List all bindings between a specific exchange and queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

queue
required
string

Name of queue.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create queue binding

Create a binding between an exchange and a queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

queue
required
string

Name of queue.

Request Body schema: application/json
routing_key
required
string
arguments
object

Responses

Request samples

Content type
application/json
{
  • "routing_key": "string",
  • "arguments": { }
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

List queue binding

List a specific binding between an exchange and queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

queue
required
string

Name of queue.

props
required
string

The properties_key from a list bindings response.

Responses

Response samples

Content type
application/json
{
  • "source": "string",
  • "vhost": "string",
  • "destination": "string",
  • "destination_type": "exchange",
  • "routing_key": "string",
  • "arguments": { },
  • "properties_key": "string"
}

Delete queue binding

Delete a specific binding between an exchange and queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

queue
required
string

Name of queue.

props
required
string

The properties_key from a list bindings response.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

List exchange bindings

List all bindings between two exchanges.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

destination
required
string

Name of exchange (destination).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create exchange binding

Create a binding between two exchanges.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

destination
required
string

Name of exchange (destination).

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

List exchange binding

List a specific binding between two exchanges.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

destination
required
string

Name of exchange (destination).

props
required
string

The properties_key from a list bindings response.

Responses

Response samples

Content type
application/json
{
  • "source": "string",
  • "vhost": "string",
  • "destination": "string",
  • "destination_type": "exchange",
  • "routing_key": "string",
  • "arguments": { },
  • "properties_key": "string"
}

Delete exchange binding

Delete a specific binding between two exchanges.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

destination
required
string

Name of exchange (destination).

props
required
string

The properties_key from a list bindings response.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

channels

Get information about open channels.

List all channels

Details for all open channels.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List channels by vhost

Details for all open channels for a specific vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List channel

Details for a specific channel.

path Parameters
name
required
string

Name of channel.

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "state": "string",
  • "message_stats": {
    },
  • "consumer_details": [
    ]
}

connections

Manage open connections.

List all connections

Details for all open connections.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List connections by vhost

Details for all open connections for a specific vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List connection

Details for specific connection.

path Parameters
name
required
string

Name of connection.

Responses

Response samples

Content type
application/json
{
  • "channels": 0,
  • "connected_at": 0,
  • "type": "string",
  • "channel_max": 0,
  • "timeout": 0,
  • "client_properties": {
    },
  • "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": {
    },
  • "recv_oct": 0,
  • "recv_oct_details": {
    },
  • "channel_created": 0,
  • "channel_created_details": {
    },
  • "channel_closed": 0,
  • "channel_closed_details": {
    }
}

Close connection

Close a specific connection.

path Parameters
name
required
string

Name of connection.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

List channels by connection

Details for open channels for specific connection.

path Parameters
name
required
string

Name of connection.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

consumers

Manage connected consumers.

List all consumers

List all consumers.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List consumers by vhost

List all consumers for a specific vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cancel consumer

Cancel a specific consumer (unsubscribe).

path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

definitions

Import and export server definitions.

Definitions

Get all server definitions (vhosts, users, queues, bindings, etc.).

Responses

Response samples

Content type
application/json
{
  • "lavinmq_version": "string",
  • "users": [
    ],
  • "vhosts": [
    ],
  • "queues": [
    ],
  • "exchanges": [
    ],
  • "bindings": [
    ],
  • "permissions": [
    ],
  • "policies": [
    ],
  • "parameters": [
    ],
  • "global_parameters": [
    ]
}

Import definitions

Import server definitions. Merged with existing definitions on the server.

Request Body schema: application/json
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)

Responses

Request samples

Content type
application/json
{
  • "users": [
    ],
  • "vhosts": [
    ],
  • "queues": [
    ],
  • "exchanges": [
    ],
  • "bindings": [
    ],
  • "permissions": [
    ],
  • "policies": [
    ],
  • "parameters": [
    ],
  • "global_parameters": [
    ]
}

Response samples

Content type
application/json
{
  • "lavinmq_version": "string",
  • "users": [
    ],
  • "vhosts": [
    ],
  • "queues": [
    ],
  • "exchanges": [
    ],
  • "bindings": [
    ],
  • "permissions": [
    ],
  • "policies": [
    ],
  • "parameters": [
    ],
  • "global_parameters": [
    ]
}

Upload definitions

Upload file with server definitions. Merged with existing definitions on the server.

Request Body schema: multipart/form-data
file
string <binary>

JSON file with definitions, uses the same format as the request body of the POST /definitions endpoint.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Definitions by vhost

Get definitions for a specifc vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
{
  • "lavinmq_version": "string",
  • "queues": [
    ],
  • "exchanges": [
    ],
  • "bindings": [
    ],
  • "policies": [
    ]
}

Import definitions by vhost

Import definitions for a specifc vhost. Merged with existing definitions on the server.

path Parameters
vhost
required
string

Name of vhost.

Request Body schema: multipart/form-data
Array of objects (definitions_queues)
Array of objects (definitions_exchanges)
Array of objects (bindings)
Array of objects (policies)
Array of objects (parameters)

Responses

Response samples

Content type
application/json
{
  • "lavinmq_version": "string",
  • "users": [
    ],
  • "vhosts": [
    ],
  • "queues": [
    ],
  • "exchanges": [
    ],
  • "bindings": [
    ],
  • "permissions": [
    ],
  • "policies": [
    ],
  • "parameters": [
    ],
  • "global_parameters": [
    ]
}

Upload vhost definitions

Upload file with vhost definitions. Merged with existing definitions on the server.

path Parameters
vhost
required
string

Name of vhost.

Request Body schema: multipart/form-data
file
string <binary>

JSON file with vhost definitions, uses the same format as the request body of the POST /definitions/{vhost} endpoint.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

exchanges

Manage exchanges.

List all exchanges

List all exchanges.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List exchanges by vhost

List all exchanges for a specific vhost.

path Parameters
vhost
required
string

Name of vhost

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List exchange

Find a specific exchange by vhost and name.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

Responses

Response samples

Content type
application/json
{
  • "type": "direct",
  • "arguments": { },
  • "auto_delete": true,
  • "durable": true,
  • "effective_policy_definition": { },
  • "internal": true,
  • "message_stats": {
    },
  • "name": "string",
  • "policy": { },
  • "vhost": "string"
}

Create/update exchange

Create a new exchange, or update an existing exchange.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "type": "direct",
  • "durable": false,
  • "auto_delete": false,
  • "internal": false,
  • "delayed": true,
  • "arguments": { }
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Delete exchange

Remove a specific exchange.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Bindings (source)

List all bindings where the specific exchange is the source.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bindings (destination)

List all bindings where the specific exchange is the destination.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Publish message

Publish a message to the specific exchange. Check the response body to understand if the message was successfully routed or not.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of exchange.

Request Body schema: application/json
required
object
routing_key
required
string
payload
required
string
payload_encoding
required
string
Enum: "string" "base64"

Responses

Request samples

Content type
application/json
{
  • "properties": {
    },
  • "routing_key": "string",
  • "payload": "string",
  • "payload_encoding": "string"
}

Response samples

Content type
application/json
{
  • "routed": true
}

main

Query the server for various information (e.g. shovels, federation links, extensions).

Server info

Various server information.

Responses

Response samples

Content type
application/json
{
  • "lavinmq_version": "string",
  • "exchange_types": [
    ],
  • "listeners": [
    ],
  • "message_stats": {
    },
  • "node": "string",
  • "object_totals": {
    },
  • "queue_totals": {
    },
  • "recv_oct_details": {
    },
  • "send_oct_details": {
    },
  • "uptime": 0
}

User info

Info about the authenticated user.

Responses

Response samples

Content type
application/json
{
  • "tags": "administrator",
  • "hashing_algorithm": "SHA512",
  • "password_hash": "string",
  • "name": "string"
}

Aliveness test

Declares a queue, publishes and consumes a message. Note: to prevent churn, the aliveness queue is not removed.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

List shovels

List all shovels.

Responses

Response samples

Content type
application/json
[ ]

List shovels by vhost

List all shovels for specific vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[ ]

List federation links by vhost

List all federation links for specific vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[ ]

List extensions

List all extensions.

Responses

Response samples

Content type
application/json
[
  • { }
]

nodes

Get node statistics.

Statistics for all nodes

Get statistics for all nodes.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Statistics for single node

Get statistics for specific node.

path Parameters
name
required
string

Name of node.

Responses

Response samples

Content type
application/json
{
  • "applications": {
    },
  • "channel_closed": 0,
  • "channel_closed_details": {
    },
  • "channel_created": 0,
  • "channel_created_details": {
    },
  • "connection_closed": 0,
  • "connection_closed_details": {
    },
  • "connection_created": 0,
  • "connection_created_details": {
    },
  • "cpu_sys_details": {
    },
  • "cpu_sys_time": 0,
  • "cpu_user_details": {
    },
  • "cpu_user_time": 0,
  • "db_dir": "string",
  • "disk_free": 0,
  • "disk_free_details": {
    },
  • "disk_total": 0,
  • "disk_total_details": {
    },
  • "fd_total": 0,
  • "fd_used": 0,
  • "io_read_count": 0,
  • "io_read_details": {
    },
  • "io_write_count": 0,
  • "io_write_details": {
    },
  • "mem_limit": 0,
  • "mem_used": 0,
  • "mem_used_details": {
    },
  • "name": "string",
  • "os_pid": "string",
  • "partitions": [ ],
  • "proc_used": 0,
  • "processors": "string",
  • "queue_declared": 0,
  • "queue_declared_details": {
    },
  • "queue_deleted": 0,
  • "queue_deleted_details": {
    },
  • "run_queue": 0,
  • "running": true,
  • "sockets_used": 0,
  • "uptime": 0
}

parameters

Manage parameters.

List all parameters

List all parameters.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List parameters by component

List all parameters for a specific component.

path Parameters
component
required
string

Name of component.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List parameters by component and vhost

List all parameters for a specific component and vhost.

path Parameters
component
required
string

Name of component.

vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List parameter

List a specific parameter.

path Parameters
component
required
string

Name of component.

vhost
required
string

Name of vhost.

name
required
string

Name of parameter.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "value": "string",
  • "component": "shovel",
  • "vhost": "string"
}

Create/update parameter

Create or update a parameter.

path Parameters
component
required
string

Name of component.

vhost
required
string

Name of vhost.

name
required
string

Name of parameter.

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Delete parameter

Remove a specific parameter.

path Parameters
component
required
string

Name of component.

vhost
required
string

Name of vhost.

name
required
string

Name of parameter.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

List global parameters

List all global parameters.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List global parameter

List specific global parameter.

path Parameters
name
required
string

Name of global parameter.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "value": "string",
  • "component": "shovel",
  • "vhost": "string"
}

Create/update global parameter

Create or update a global parameter.

path Parameters
name
required
string

Name of global parameter.

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Delete global parameter

Remove a specific global parameter.

path Parameters
name
required
string

Name of global parameter.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

policies

Manage policies.

List all policies

List all policies.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List policies for vhost

List all policies for a specific vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List policy

List a specific policy.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of policy.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "vhost": "string",
  • "pattern": "string",
  • "apply-to": "all",
  • "priority": 0,
  • "definition": { }
}

Create/update policy

Create or update a policy.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of policy.

Request Body schema: application/json
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"

Responses

Request samples

Content type
application/json
{
  • "pattern": "string",
  • "definition": { },
  • "priority": 0,
  • "apply-to": "all"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Delete policy

Delete a policy.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of policy.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

permissions

Manage permissions.

List all permissions

List permissions for each vhost in the server.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List permissions by vhost and user

List permissions by vhost and user.

path Parameters
vhost
required
string

Name of the vhost.

user
required
string

Name of the user.

Responses

Response samples

Content type
application/json
{
  • "user": "string",
  • "vhost": "string",
  • "configure": "string",
  • "read": "string",
  • "write": "string"
}

Create/update permissions

Create or update permissions by vhost and user.

path Parameters
vhost
required
string

Name of the vhost.

user
required
string

Name of the user.

Request Body schema: application/json
configure
required
string

Configure permissions (regular expression).

read
required
string

Read permissions (regular expression).

write
required
string

Write permissions (regular expression).

Responses

Request samples

Content type
application/json
{
  • "configure": "string",
  • "read": "string",
  • "write": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Delete permissions

Delete permissions by vhost and user.

path Parameters
vhost
required
string

Name of the vhost.

user
required
string

Name of the user.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

queues

Manage queues.

List all queues

List all queues in the server.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List queues for vhost

List all queues for specific vhost.

path Parameters
vhost
required
string

Name of vhost.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List queue

Find specific queue by name and vhost.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "message_stats": {
    },
  • "internal": true,
  • "first_message_timestamp": 0,
  • "last_message_timestamp": 0,
  • "consumer_details": [ ]
}

Create/update queue

Create new queue under given vhost, or update an existing queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Request Body schema: application/json
durable
boolean
Default: false
auto_delete
boolean
Default: false
arguments
object

Responses

Request samples

Content type
application/json
{
  • "durable": false,
  • "auto_delete": false,
  • "arguments": { }
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Delete queue

Remove a specific queue by name and vhost.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Pause queue

Pause the queue. When the queue is paused, messages are not delivered to consumers.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Resume queue

Resume the queue. When the queue is paused, messages are not delivered to consumers.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List queue bindings

List bindings for a specific queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Responses

Response samples

Content type
application/json
{
  • "source": "string",
  • "vhost": "string",
  • "destination": "string",
  • "destination_type": "exchange",
  • "routing_key": "string",
  • "arguments": { },
  • "properties_key": "string"
}

Purge queue

Delete all contents of a queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Get messages from queue

Get one ore more messages from a specific queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Request Body schema: application/json
count
integer
Default: 1
ack_mode
string
Default: "get"
encoding
string
Default: "auto"
Enum: "auto" "base64"
truncate
string
requeue
boolean

Responses

Request samples

Content type
application/json
{
  • "count": 1,
  • "ack_mode": "get",
  • "encoding": "auto",
  • "truncate": "string",
  • "requeue": true
}

Response samples

Content type
application/json
[
  • {
    }
]

List queue size details

List size details for a specific queue.

path Parameters
vhost
required
string

Name of vhost.

name
required
string

Name of queue.

Responses

Response samples

Content type
application/json
{
  • "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
}

users

Manage users.

List all users

List all users in the server.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List users with no permissions

List all users that doesn't have any permissions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bulk delete users

Delete multiple users.

Request Body schema: application/json
users
required
Array of strings

List of users to delete.

Responses

Request samples

Content type
application/json
{
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

List user

Find a specific user by name.

path Parameters
name
required
string

Name of the user.

Responses

Response samples

Content type
application/json
{
  • "tags": "administrator",
  • "hashing_algorithm": "SHA512",
  • "password_hash": "string",
  • "name": "string"
}

Create/update user

Create new user, or update an existing user.

path Parameters
name
required
string

Name of the user.

Request Body schema: application/json
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 password_hash is required.

Responses

Request samples

Content type
application/json
{
  • "tags": "administrator",
  • "hashing_algorithm": "SHA512",
  • "password_hash": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Delete user

Remove a specific user by name.

path Parameters
name
required
string

Name of the user.

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

List permissions of user

List permissions by user.

path Parameters
name
required
string

Name of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

vhosts

Manage vhosts.

List all vhosts

List all vhosts in the server.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List vhost

Find a specific vhost by name.

path Parameters
name
required
string

Name of the vhost

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "dir": "string",
  • "cluster_state": { },
  • "messages": 0,
  • "messages_unacknowledged": 0,
  • "messages_ready": 0,
  • "messages_stats": {
    }
}

Create/update vhost

Create a new vhost, or update an existing vhost.

path Parameters
name
required
string

Name of the vhost

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

Delete vhost

Remove a specific vhost by name.

path Parameters
name
required
string

Name of the vhost

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "reason": "string"
}

List permissions of vhost

List the permissions for a vhost.

path Parameters
name
required
string

Name of the vhost

Responses

Response samples

Content type
application/json
{
  • "user": "string",
  • "vhost": "string",
  • "configure": "string",
  • "read": "string",
  • "write": "string"
}