This article shows how to search for ActiveMQ connections using the REST API.
Search ActiveMQ Connections
GET /activemq/connections
Search for ActiveMQ connections with optional filters and parameters.
Example Request
curl -X 'GET' \ 'http://<hostname>:8019/rest/v1/activemq/connections?nodeName=CMACTIVEMQ&managerName=Cloudactmq&brokerName=JKMessageBus' \ -H 'accept: application/json' \ -H 'Authorization: Basic QWRtaW46YWRtaW4='
Query Parameters
| Parameter | Type | Description |
|---|---|---|
nodeName |
string (query) | Wildcard node name for search. |
managerName |
string (query) | Wildcard manager name for search. |
brokerName |
string (query) | Wildcard ActiveMQ broker name for search. |
connectionName |
string (query) | Wildcard ActiveMQ connection name for search. |
projects |
string (query) | Filter by projects (comma-separated list of project IDs). |
filter |
string (query) | Filter by attribute using logical operators. |
order |
string (query) | Order results by specific attributes (e.g., asc/desc). |
limit |
integer (query) | Limit number of found objects. |
attributes |
string (query) | A comma-separated list of attributes or attribute sections to retrieve. |
validateAccessForUser |
string (query) | Validate endpoint access for user. |
Response Codes
200 OK – Returns an array of matching ActiveMQ connection objects.
* – Error response.
Example Response
200 OK: Returns ActiveMQ connection objects
[
{
"wgsName": "MQM",
"nodeName": "CMACTIVEMQ",
"managerName": "Cloudactmq",
"brokerName": "JKMessageBus",
"connectionName": "DurableClient",
"general": {
"connectionId": "12345",
"clientId": "DurableClient",
"protocol": "OpenWire",
"status": "Connected",
"remoteAddress": "tcp://172.16.31.100:61616",
"userName": "admin",
"uptime": "1 hour 15 minutes"
},
"state": {
"messagesSent": 523,
"messagesReceived": 476,
"pendingMessages": 12,
"lastActivityTime": "2025-10-10T11:37:46Z"
},
"customProperties": {
"property1": "value1",
"property2": "value2"
}
}
]
Reference Articles
Using the REST API using the Navigator demo system
Performing REST API operations using the Swagger UI