OpenAPI Reference

The full OpenAPI definition is generated from the codebase (see Swagger generation).

The live reference below renders BifroMQ-API.yaml directly.

• putDisable store balancer
• putEnable store balancer
• postRetain a message to given topic
• delExpire all retain messages using given expiry time
• getGet the session information of the given user and client id
• delExpire inactive persistent session using given expiry time
• getGet the store balancer state
• getGet cluster membership known from current node
• getGet the expected load rules of a store balancer
• putSet the expected load rules of a store balancer
• getGet the service landscape information
• getGet the inbox state of a mqtt session
• getGet the store landscape information
• getGet the ranges information in a store node
• getGet the traffic rules of a service
• putSet the traffic rules of a service
• delDisconnect a MQTT client connection
• getList the name of services in BifroMQ cluster
• getList the name of stores in BifroMQ cluster
• postPublish a message to given topic
• putSet group tag to a server in a service
• putAdd a topic subscription to a mqtt session
• delRemove a topic subscription from a mqtt session

API docs by Redocly

BifroMQ RESTful API (4.0.0-incubating)

Download OpenAPI specification:Download

Disable store balancer

header Parameters

req_id	integer <int64> optional caller provided request id
store_name required	string the store name
balancer_factory_class required	string the full qualified name of balancer factory class configured for the store

Request Body schema: application/json

Schema not provided

Responses

https://bifromq.apache.org/store/balancer/disable

Enable store balancer

header Parameters

req_id	integer <int64> optional caller provided request id
store_name required	string the store name
balancer_factory_class required	string the full qualified name of balancer factory class configured for the store

Request Body schema: application/json

Schema not provided

Responses

https://bifromq.apache.org/store/balancer/enable

Retain a message to given topic

header Parameters

req_id	integer <int64> optional, caller provided request id
tenant_id required	string the tenant id
topic required	string the message topic
qos required	integer <int32> Enum: 0 1 2 QoS of the message to be retained
expiry_seconds	integer <int32> the message expiry seconds
client_type required	string the caller client type
client_meta_*	string the metadata header about caller client, must be started with client_meta_

Request Body schema: application/octet-stream

required

Message payload will be treated as binary

Schema not provided

Responses

https://bifromq.apache.org/retain

Expire all retain messages using given expiry time

header Parameters

req_id	integer <int64> optional caller provided request id
tenant_id required	string the tenant id
expiry_seconds required	integer <int32> the overridden retain message expiry time in seconds

Responses

https://bifromq.apache.org/retain

Get the session information of the given user and client id

header Parameters

req_id	integer <int64> optional caller provided request id
tenant_id required	string the id of tenant
user_id required	string the id of user who established the session
client_id required	string the client id of the mqtt session

Responses

https://bifromq.apache.org/session

Expire inactive persistent session using given expiry time

header Parameters

req_id	integer <int64> optional caller provided request id
tenant_id required	string the tenant id
expiry_seconds required	integer <int32> the overridden session expiry time in seconds

Responses

https://bifromq.apache.org/session

Get the store balancer state

header Parameters

req_id	integer <int64> optional caller provided request id
store_name required	string the store name
balancer_factory_class required	string the full qualified name of balancer factory class configured for the store

Responses

https://bifromq.apache.org/store/balancer

Get cluster membership known from current node

header Parameters

req_id

integer <int64> optional caller provided request id

Responses

https://bifromq.apache.org/cluster

Get the expected load rules of a store balancer

header Parameters

req_id	integer <int64> optional caller provided request id
store_name required	string the service name
balancer_factory_class required	string the full qualified name of balancer factory class configured for the store

Responses

https://bifromq.apache.org/store/balancer/rules

Set the expected load rules of a store balancer

header Parameters

req_id	integer <int64> optional caller provided request id
store_name required	string the store name
balancer_factory_class required	string the full qualified name of balancer factory class configured for the store

Request Body schema: application/json

Schema not provided

Responses

https://bifromq.apache.org/store/balancer/rules

Get the service landscape information

header Parameters

req_id	integer <int64> optional caller provided request id
service_name required	string the service name

Responses

https://bifromq.apache.org/service/landscape

Get the inbox state of a mqtt session

header Parameters

req_id	integer <int64> optional caller provided request id
tenant_id required	string the id of tenant
user_id required	string the id of user who established the session
client_id required	string the client id of the mqtt session

Responses

https://bifromq.apache.org/session/inbox

Get the store landscape information

header Parameters

req_id	integer <int64> optional caller provided request id
store_name required	string the store name

Responses

https://bifromq.apache.org/store/landscape

Get the ranges information in a store node

header Parameters

req_id	integer <int64> optional caller provided request id
store_name required	string the store name
store_id required	string the store id

Responses

https://bifromq.apache.org/store/ranges

Get the traffic rules of a service

header Parameters

req_id	integer <int64> optional caller provided request id
service_name required	string the service name

Responses

https://bifromq.apache.org/service/traffic

Set the traffic rules of a service

header Parameters

req_id	integer <int64> optional caller provided request id
service_name required	string the service name

Request Body schema: application/json

Schema not provided

Responses

https://bifromq.apache.org/service/traffic

Disconnect a MQTT client connection

header Parameters

req_id	integer <int64> optional caller provided request id
tenant_id required	string the tenant id
user_id	string the user id of the MQTT client connection to be disconnected
client_id	string the client id of the mqtt session
server_redirect	string Enum: "no" "move" "temp_use" indicate if the client should redirect to another server
server_reference	string <= 65535 characters indicate the server reference to redirect to
client_type required	string the caller client type
client_meta_*	string the metadata header about the caller client, must be started with client_meta_

Responses

https://bifromq.apache.org/kill

List the name of services in BifroMQ cluster

header Parameters

req_id

integer <int64> optional caller provided request id

Responses

https://bifromq.apache.org/services

List the name of stores in BifroMQ cluster

header Parameters

req_id

integer <int64> optional caller provided request id

Responses

https://bifromq.apache.org/stores

Publish a message to given topic

header Parameters

req_id	integer <int64> optional caller provided request id
tenant_id required	string the tenant id
topic required	string the message topic
qos required	integer <int32> Enum: 0 1 2 QoS of the message to be published
expiry_seconds	integer <int32> the message expiry seconds, must be positive
client_type required	string the caller client type
client_meta_*	string the metadata header about caller client, must be started with client_meta_

Request Body schema: application/octet-stream

required

Message payload will be treated as binary

Schema not provided

Responses

https://bifromq.apache.org/pub

Set group tag to a server in a service

header Parameters

req_id	integer <int64> optional caller provided request id
service_name required	string the service name
server_id required	string the service server id

Request Body schema: application/json

required

Array

string

Responses

https://bifromq.apache.org/service/group

Request samples

• Payload

Content type

application/json

[

• "string"

]

Add a topic subscription to a mqtt session

header Parameters

req_id	integer <int64> optional caller provided request id
tenant_id required	string the id of tenant
user_id required	string the id of user who established the session
client_id required	string the client id of the mqtt session
topic_filter required	string the topic filter to add
sub_qos required	integer <int32> Enum: 0 1 2 the qos of the subscription

Responses

https://bifromq.apache.org/sub

Remove a topic subscription from a mqtt session

header Parameters

req_id	integer <int64> optional caller provided request id
tenant_id required	string the id of tenant
user_id required	string the id of user who established the session
client_id required	string the client id of the mqtt session
topic_filter required	string the topic filter to remove

Responses

https://bifromq.apache.org/unsub