This article shows how to search for ActiveMQ brokers using the REST API.
Search ActiveMQ Brokers
GET /activemq/brokers
Retrieves a list of ActiveMQ brokers based on the provided search parameters.
Example Request
curl -X 'GET' \ 'http://<hostname>:8019/rest/v1/activemq/brokers?nodeName=CMACTIVEMQ&managerName=Activemq-server&brokerName=DemoBroker' \ -H 'accept: application/json' \ -H 'Authorization: Basic QWRtaW46YWRtaW4='
Query Parameters
| Parameter | Type | Description |
|---|---|---|
nodeName |
string | Wildcard node name for search. |
managerName |
string | Wildcard manager name for search. |
brokerName |
string | Wildcard ActiveMQ Broker name for search. |
projects |
string | Filter by projects (comma-separated list of project IDs). |
filter |
string | Filter by attribute |
order |
string | Order results by attributes |
limit |
integer | Limit of found objects. |
attributes |
string | Comma-separated list of attributes or attribute sections to retrieve. |
validateAccessForUser |
string | Validate endpoint access for user. |
Response Codes
200 OK – Returns matching broker objects.
* – Error response, returns
ErrorPojo.
Example Response
200 OK – Brokers retrieved successfully.
[
{
"wgsName": "MQM",
"nodeName": "CMACTIVEMQ",
"managerName": "Activemq-server",
"brokerName": "DemoBroker",
"uri": "tcp://Middleware4:61616",
"general": {
"brokerId": "broker-001",
"brokerVersion": "5.16.5",
"statisticsEnabled": true,
"memoryLimit": 67108864,
"storeLimit": 1073741824,
"tempLimit": 536870912,
"jobSchedulerStoreLimit": 268435456,
"persistent": true,
"slave": false,
"vmURL": "vm://DemoBroker",
"dataDirectory": "/var/lib/activemq/data",
"jmsJobScheduler": "enabled",
"maxUncommittedCount": 1000
},
"state": {
"lastUpdated": "2025-09-30T11:30:40.848Z",
"uptime": "3 days 4 hours",
"uptimeMillis": 277200000,
"currentConnectionsCount": 25,
"totalConnectionsCount": 1024,
"totalEnqueueCount": 50000,
"totalDequeueCount": 49500,
"totalConsumerCount": 12,
"totalProducerCount": 8,
"totalMessageCount": 500,
"averageMessageSize": 2048,
"maxMessageSize": 1048576,
"minMessageSize": 128,
"memoryPercentUsage": 45,
"storePercentUsage": 32,
"tempPercentUsage": 18,
"jobSchedulerStorePercentUsage": 10,
"totalMaxUncommittedExceededCount": 0,
"transportConnectorsCount": 5,
"topicsCount": 12,
"queuesCount": 8,
"temporaryTopicsCount": 1,
"temporaryQueuesCount": 2,
"topicSubscribersCount": 15,
"durableTopicSubscribersCount": 5,
"inactiveDurableTopicSubscribersCount": 2,
"queueSubscribersCount": 10,
"temporaryTopicSubscribersCount": 1,
"temporaryQueueSubscribersCount": 1,
"topicProducersCount": 6,
"queueProducersCount": 4,
"temporaryTopicProducersCount": 0,
"temporaryQueueProducersCount": 0,
"dynamicDestinationProducersCount": 3
},
"jobs": {
"totalJobCount": 120,
"scheduledJobCount": 50,
"canceledJobCount": 5,
"successJobCount": 60,
"failedJobCount": 3,
"readyJobCount": 2,
"pendingJobCount": 0,
"jobIds": [
"job-1001",
"job-1002",
"job-1003"
]
},
"customProperties": {
"environment": "production",
"region": "us-east-1",
"owner": "admin-team"
}
}
]