Skip to main content

Manager API

/api/v1/plugins

GET

Summary

Get plugin list

Parameters

Query Parameters

Parameter NameDescription
offsetnumber of records to skip before starting to return results. Default : 0
limitmaximum number of records to return in a single response. Default : 10

Response

/api/v1/:tenant_id/clients

GET

Summary

Get client list with tenant id

Parameters

URL Path Parameter:

Parameter NameDescription
tenant_idtenant identifier

Query Parameters

Parameter NameDescription
offsetnumber of records to skip before starting to return results. Default : 0
limitmaximum number of records to return in a single response. Default : 10

Response

{
"meta": {
"offset": 0,
"limit": 10,
"total": 1
},
"data": [{
"tenant_identifier": "public",
"client_id": "client_1",
"subscription_topics": ["/a/b"],
"session_state": "Activate"
}]
}

/api/v1/:tenant_id/clients/:client_id/kickopff

POST

Summary

Kick off MQTT connections with specified tenant ID and client ID.

Parameters

Parameter NameDescription
tenant_idtenant identifier
client_idmqtt client identifier

/api/v1/system_info

GET

Summary

Get system info.

Parameters

None

/api/v1/:tenant_id/topics

GET

Summary

Get topics list.

Parameters

URL Path Parameter:

Parameter NameDescription
tenant_idtenant identifier

Query Parameters

Parameter NameDescription
offsetnumber of records to skip before starting to return results. Default : 0
limitmaximum number of records to return in a single response. Default : 10

Responses

{
"meta": {
"offset": 0,
"limit": 10,
"total": 1
},
"data": [{
"topic": "client_1",
"client_id": "/a/b",
"qos": 0
}]
}