Change ActiveMQ Broker (API) – meshIQ

This article shows how to update the configuration of a specific ActiveMQ broker using the REST API.

Change ActiveMQ Consumer

PATCH /activemq/brokers/{nodeName}/{managerName}/{brokerName}

Updates the configuration details of a specific ActiveMQ broker.

Example Request

curl -X 'PATCH' \
  'http://<hostname>:8019/rest/v1/activemq/brokers/CMACTIVEMQ/Activemq-server/DemoBroker' \
  -H 'accept: */*' \
  -H 'Authorization: Basic QWRtaW46YWRtaW4=' \
  -H 'Content-Type: application/json' \
  -d '{
  "wgsName": "MQM",
  "nodeName": "CMACTIVEMQ",
  "managerName": "Activemq-server",
  "brokerName": "TestBroker",
  "uri": "tcp://localhost:61616",
}'

Query Parameters

Parameter	Type	Description
`jobDate`	integer	Schedule job date (Unix Timestamp).
`jobTags`	string	Comma-separated list of job tags (used only with jobDate).
`validateAccessForUser`	string	Validate endpoint access for the user.
`waitForRead`	boolean	Wait for cache update.

Request Body

{
  "wgsName": "MQM",
  "nodeName": "string",
  "managerName": "string",
  "brokerName": "string",
  "uri": "string",
  "general": {
    "brokerId": "string",
    "brokerVersion": "string",
    "statisticsEnabled": true,
    "memoryLimit": 0,
    "storeLimit": 0,
    "tempLimit": 0,
    "jobSchedulerStoreLimit": 0,
    "persistent": true,
    "slave": true,
    "vmURL": "string",
    "dataDirectory": "string",
    "jmsJobScheduler": "string",
    "maxUncommittedCount": 0
  },
  "state": {
    "lastUpdated": "2025-09-29T13:43:53.022Z",
    "uptime": "string",
    "uptimeMillis": 0,
    "currentConnectionsCount": 0,
    "totalConnectionsCount": 0,
    "totalEnqueueCount": 0,
    "totalDequeueCount": 0,
    "totalConsumerCount": 0,
    "totalProducerCount": 0,
    "totalMessageCount": 0,
    "averageMessageSize": 0,
    "maxMessageSize": 0,
    "minMessageSize": 0,
    "memoryPercentUsage": 0,
    "storePercentUsage": 0,
    "tempPercentUsage": 0,
    "jobSchedulerStorePercentUsage": 0,
    "totalMaxUncommittedExceededCount": 0,
    "transportConnectorsCount": 0,
    "topicsCount": 0,
    "queuesCount": 0,
    "temporaryTopicsCount": 0,
    "temporaryQueuesCount": 0,
    "topicSubscribersCount": 0,
    "durableTopicSubscribersCount": 0,
    "inactiveDurableTopicSubscribersCount": 0,
    "queueSubscribersCount": 0,
    "temporaryTopicSubscribersCount": 0,
    "temporaryQueueSubscribersCount": 0,
    "topicProducersCount": 0,
    "queueProducersCount": 0,
    "temporaryTopicProducersCount": 0,
    "temporaryQueueProducersCount": 0,
    "dynamicDestinationProducersCount": 0
  },
  "jobs": {
    "totalJobCount": 0,
    "scheduledJobCount": 0,
    "canceledJobCount": 0,
    "successJobCount": 0,
    "failedJobCount": 0,
    "readyJobCount": 0,
    "pendingJobCount": 0,
    "jobIds": [
      "string"
    ]
  },
  "customProperties": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Response Codes

204 No Content – Object updated successfully.
304 Not Modified – No changes applied.
* – Error response, returns ErrorPojo.

Response Header

200 OK: Broker updated successfully.

 access-control-allow-credentials: true 
 access-control-allow-origin: http://<hostname>:8019 
 date: Fri,26 Sep 2025 14:50:34 GMT 
 server: Jetty(10.0.22) 
 vary: Origin

Reference Articles

Using the REST API using the Navigator demo system

Performing REST API operations using the Swagger UI