Change ActiveMQ Consumer (API) – meshIQ

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

Change ActiveMQ Consumer

PATCH /activemq/consumers/{nodeName}/{managerName}/{brokerName}/{consumerName}

Updates the details of a specific ActiveMQ consumer.

Example Request

curl -X 'PATCH' \
  'http://<hostname>:8019/rest/v1/activemq/consumers/CMACTIVEMQ/Activemq-serve/DemoBroker/%20NOTSET%3A0%3A-1' \
  -H 'accept: */*' \
  -H 'Authorization: Basic QWRtaW46YWRtaW4=' \
  -H 'Content-Type: application/json' \
  -d '{
  "wgsName": "MQM",
  "nodeName": "CMACTIVEMQ",
  "managerName": "Activemq-serve",
  "brokerName": "DemoBroker",
  "consumerName": "Consumer1",
}

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",
  "consumerName": "string",
  "uri": "string",
  "general": {
    "clientId": "string",
    "connectionId": "string",
    "sessionId": 0,
    "subscriptionId": 0,
    "destinationName": "string",
    "selector": "string",
    "destinationQueue": true,
    "destinationTopic": true,
    "destinationTemporary": true,
    "maximumPendingMessageLimit": 0,
    "priority": 0,
    "subscriptionName": "string",
    "durable": true,
    "userName": "string",
    "maximumPendingQueueSize": 0
  },
  "state": {
    "lastUpdated": "2025-09-29T08:28:47.098Z",
    "active": true,
    "network": true,
    "pendingQueueSize": 0,
    "dispatchedQueueSize": 0,
    "messageCountAwaitingAcknowledge": 0,
    "dispatchedCounter": 0,
    "enqueueCounter": 0,
    "dequeueCounter": 0,
    "prefetchSize": 0,
    "retroactive": true,
    "exclusive": true,
    "noLocal": true,
    "dispatchAsync": true,
    "slowConsumer": true,
    "consumedCount": 0,
    "connection": "string",
    "discardedCount": 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: Consumer 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